Skip to content

Commit

Permalink
Eliminate Javadoc errors
Browse files Browse the repository at this point in the history
  • Loading branch information
merks committed Sep 18, 2024
1 parent 4a873fb commit ad97cb5
Show file tree
Hide file tree
Showing 58 changed files with 307 additions and 222 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Manifest-Version: 1.0
Bundle-ManifestVersion: 2
Bundle-Name: %pluginName
Bundle-SymbolicName: org.eclipse.equinox.p2.artifact.repository;singleton:=true
Bundle-Version: 1.5.400.qualifier
Bundle-Version: 1.5.500.qualifier
Bundle-Activator: org.eclipse.equinox.internal.p2.artifact.repository.Activator
Bundle-Vendor: %providerName
Bundle-Localization: plugin
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,7 @@ public final class PGPSignatureVerifier extends ProcessingStep {

/**
* ID of the registering
* <code>org.eclipse.equinox.p2.artifact.repository.processingSteps</tt>
* extension.
* {@code org.eclipse.equinox.p2.artifact.repository.processingSteps} extension.
*/
public static final String ID = "org.eclipse.equinox.p2.processing.PGPSignatureCheck"; //$NON-NLS-1$

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,13 @@
import org.xml.sax.SAXException;

/**
* Mirror support class for repositories. This class implements
* mirror support equivalent to the mirroring of update manager sites. A repository
* optionally provides a mirror URL via the {@link IRepository#PROP_MIRRORS_URL} key.
* The contents of the file at this URL is expected to be an XML document
* containing a list of <mirror> elements. The mirrors are assumed to be already
* sorted geographically with closer mirrors first.
* <br><br>
* Mirror support class for repositories. This class implements mirror support
* equivalent to the mirroring of update manager sites. A repository optionally
* provides a mirror URL via the {@link IRepository#PROP_MIRRORS_URL} key. The
* contents of the file at this URL is expected to be an XML document containing
* a list of &lt;mirror&gt; elements. The mirrors are assumed to be already
* sorted geographically with closer mirrors first. <br>
* <br>
* Always use {@link MirrorSelector.MirrorInfoComparator} for comparison.
*/
public class MirrorSelector {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Manifest-Version: 1.0
Bundle-ManifestVersion: 2
Bundle-Name: %pluginName
Bundle-SymbolicName: org.eclipse.equinox.p2.console;singleton:=true
Bundle-Version: 1.3.400.qualifier
Bundle-Version: 1.3.500.qualifier
Bundle-Activator: org.eclipse.equinox.internal.p2.console.Activator
Bundle-Vendor: %providerName
Bundle-Localization: plugin
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -263,8 +263,8 @@ public void _provliu(CommandInterpreter interpreter) {
/**
* Lists the installable units that match the given URL and query. A third
* boolean argument can be provided where <code>true</code> means &quot;full
* query&quot; and <code>false</code> means &quote;match query&quote;. The
* default is <code>false</code>.
* query&quot; and <code>false</code> means &quot;match query&quot;. The default
* is <code>false</code>.
*/
public void _provlquery(CommandInterpreter interpreter) {
String urlString = processArgument(interpreter.nextArgument());
Expand Down Expand Up @@ -546,7 +546,7 @@ public void _provlgp(CommandInterpreter interpreter) {
* Lists the installable units that match the given profile id and query. The id
* can be &quot;this&quot; to denote the self profile. A third boolean argument
* can be provided where <code>true</code> means &quot;full query&quot; and
* <code>false</code> means &quote;match query&quote;. The default is
* <code>false</code> means &quot;match query&quot;. The default is
* <code>false</code>.
*/
public void _provlpquery(CommandInterpreter interpreter) {
Expand Down
2 changes: 1 addition & 1 deletion bundles/org.eclipse.equinox.p2.core/META-INF/MANIFEST.MF
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Manifest-Version: 1.0
Bundle-ManifestVersion: 2
Bundle-Name: %pluginName
Bundle-SymbolicName: org.eclipse.equinox.p2.core;singleton:=true
Bundle-Version: 2.12.100.qualifier
Bundle-Version: 2.12.200.qualifier
Bundle-Activator: org.eclipse.equinox.internal.p2.core.Activator
Bundle-Vendor: %providerName
Bundle-Localization: plugin
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,14 +55,13 @@ public OrderedProperties(Map<String, String> properties) {
/**
* Set the property value.
* <p>
* If a property with the key already exists, the previous
* value is replaced. Otherwise a new property is added at
* the end collection.
* If a property with the key already exists, the previous value is replaced.
* Otherwise a new property is added at the end collection.
*
* @param key must not be null
* @param value must not be null
* @return previous value associated with specified key, or <tt>null</tt>
* if there was no mapping for key.
* @return previous value associated with specified key, or {@code null} if
* there was no mapping for key.
*/
public Object setProperty(String key, String value) {
init();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Manifest-Version: 1.0
Bundle-ManifestVersion: 2
Bundle-Name: %pluginName
Bundle-SymbolicName: org.eclipse.equinox.p2.director.app;singleton:=true
Bundle-Version: 1.3.400.qualifier
Bundle-Version: 1.3.500.qualifier
Bundle-Activator: org.eclipse.equinox.internal.p2.director.app.Activator
Bundle-Vendor: %providerName
Bundle-Localization: plugin
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,16 @@ public interface ILog {

/**
*
* @deprecated Use {@link ILog#printOut()} or {@link ILog#printErr()}
* @deprecated Use {@link ILog#printOut(String)} or
* {@link ILog#printErr(String)}
*/
@Deprecated
default void log(String message) {
printOut(message);
}

/**
* Notify that logging is completed & cleanup resources
* Notify that logging is completed &amp; cleanup resources
*/
void close();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Manifest-Version: 1.0
Bundle-ManifestVersion: 2
Bundle-Name: %pluginName
Bundle-SymbolicName: org.eclipse.equinox.p2.director;singleton:=true
Bundle-Version: 2.6.400.qualifier
Bundle-Version: 2.6.500.qualifier
Bundle-Activator: org.eclipse.equinox.internal.p2.director.DirectorActivator
Bundle-Vendor: %providerName
Bundle-Localization: plugin
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,18 +59,23 @@ public Map<IInstallableUnit, RequestStatus> getRequestChanges() {
}

/**
* Returns a map of side-effects that will occur as a result of the plan being executed.
* Side-effects of an install may include:
* <p>
* Returns a map of side-effects that will occur as a result of the plan being
* executed. Side-effects of an install may include:
* </p>
* <ul>
* <li>Optional software being installed that will become satisfied once the plan
* is executed.</li>
* <li>Optional software currently in the profile that will be uninstalled as a result
* of the plan being executed. This occurs when the optional software has dependencies
* that are incompatible with the software being installed.
* This includes additional software that will be installed as a result of the change,
* or optional changes and their corresponding explanation.
* @return A map of {@link IInstallableUnit} to {@link IStatus} of the additional side effect
* status, or <code>null</code> if there are no side effects.
* <li>Optional software being installed that will become satisfied once the
* plan is executed.</li>
* <li>Optional software currently in the profile that will be uninstalled as a
* result of the plan being executed. This occurs when the optional software has
* dependencies that are incompatible with the software being installed. This
* includes additional software that will be installed as a result of the
* change, or optional changes and their corresponding explanation.</li>
* </ul>
*
* @return A map of {@link IInstallableUnit} to {@link IStatus} of the
* additional side effect status, or <code>null</code> if there are no
* side effects.
*/
public Map<IInstallableUnit, RequestStatus> getRequestSideEffects() {
return requestSideEffects;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Manifest-Version: 1.0
Bundle-ManifestVersion: 2
Bundle-Name: %Bundle-Name
Bundle-SymbolicName: org.eclipse.equinox.p2.discovery.compatibility;singleton:=true
Bundle-Version: 1.3.400.qualifier
Bundle-Version: 1.3.500.qualifier
Bundle-Vendor: %Bundle-Vendor
Bundle-RequiredExecutionEnvironment: JavaSE-17
Require-Bundle: org.eclipse.core.runtime;bundle-version="3.29.0",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

/**
* Connector Discovery extension point reader, for extension points of type
* <tt>org.eclipse.mylyn.discovery.core.connectorDiscovery</tt>
* {@code org.eclipse.mylyn.discovery.core.connectorDiscovery}
*
* @author David Green
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Manifest-Version: 1.0
Bundle-ManifestVersion: 2
Bundle-Name: %Bundle-Name
Bundle-SymbolicName: org.eclipse.equinox.p2.discovery;singleton:=true
Bundle-Version: 1.3.300.qualifier
Bundle-Version: 1.3.400.qualifier
Bundle-Vendor: %Bundle-Vendor
Bundle-RequiredExecutionEnvironment: JavaSE-17
Require-Bundle: org.eclipse.core.runtime;bundle-version="3.29.0",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -108,8 +108,7 @@ public boolean isSelected() {
/**
* support selection
*
* @param selected
* true if the item is selected, otherwise false
* @param selected true if the item is selected, otherwise false
*/
public void setSelected(boolean selected) {
this.selected = selected;
Expand All @@ -127,8 +126,8 @@ public Boolean getAvailable() {
/**
* indicate if this connector is available
*
* @param available
* true if available, false if not, or null if availability is unknown
* @param available true if available, false if not, or null if availability is
* unknown
*/
public void setAvailable(Boolean available) {
if (available != this.available || (available != null && !available.equals(this.available))) {
Expand All @@ -155,8 +154,8 @@ public void removePropertyChangeListener(String propertyName, PropertyChangeList
}

/**
* the name of the connector including the name of the organization that produces the repository if appropriate, for
* example 'Mozilla Bugzilla'.
* the name of the connector including the name of the organization that
* produces the repository if appropriate, for example 'Mozilla Bugzilla'.
*/
public String getName() {
return name;
Expand All @@ -178,7 +177,8 @@ public void setProvider(String provider) {
}

/**
* The short name of the license, for example 'EPL 1.0', 'GPL 2.0', or 'Commercial'.
* The short name of the license, for example 'EPL 1.0', 'GPL 2.0', or
* 'Commercial'.
*/
public String getLicense() {
return license;
Expand All @@ -189,10 +189,9 @@ public void setLicense(String license) {
}

/**
* A description of the connector. Plug-ins should provide a description, especially if the description is not
* self-evident from the @name and
*
* @organization.
* A description of the connector. Plug-ins should provide a description,
* especially if the description is not self-evident from the @name and
* organization.
*/
public String getDescription() {
return description;
Expand Down Expand Up @@ -244,7 +243,7 @@ public void setCertificationId(String certificationId) {
}

/**
* E.g., "(& (osgi.os=macosx) (osgi.ws=carbon))"
* E.g., "(&amp; (osgi.os=macosx) (osgi.ws=carbon))"
*/
public String getPlatformFilter() {
return platformFilter;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -281,31 +281,36 @@ public static void gatherCertificates(Map<URI, List<Certificate>> authorities, I
}

/**
* <p>
* Returns a list of URIs representing the hierarchical chain, starting from the
* root authority, to the given location. The location will always be present as
* the last element in the list. The first element represents the root
* authority.
* </p>
*
* <ul>
* <li>file:/C:/folder/file</li>
* <li>file:/C:/folder/file
* <ul>
* <li>file:/</li>
* <li>file:/C:/</li>
* <li>file:/C:/folder/</li>
* </ul>
* <li>https://host/folder/file</li>
* </li>
* <li>https://host/folder/file
* <ul>
* <li>https://host</li>
* <li>https://host/folder/</li>
* <li>https://host/folder/file</li>
* </ul>
* <li>jar:https://host/folder/file.jar!/path</li>
* </li>
* <li>jar:https://host/folder/file.jar!/path
* <ul>
* <li>https://host</li>
* <li>https://host/folder/</li>
* <li>https://host/folder/file.jar</li>
* <li>jar:https://host/folder/file.jar!/path</li>
* </ul>
* </li>
* </ul>
*
* @param location an arbitrary location.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,8 @@ public class CheckTrust extends InstallableUnitPhase {

/**
* Parameter used to populate/get artifacts to check trust. The value for this
* property is <code>Map&lt;IArtifactDescriptor, File></code>.
*
* @see org.eclipse.equinox.internal.p2.touchpoint.eclipse.actions.CheckTrustAction
* property is <code>Map&lt;IArtifactDescriptor, File></code>. It is used by
* {@code see org.eclipse.equinox.internal.p2.touchpoint.eclipse.actions.CheckTrustAction}.
*/
public static final String PARM_ARTIFACTS = "artifacts"; //$NON-NLS-1$

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Manifest-Version: 1.0
Bundle-ManifestVersion: 2
Bundle-Name: %pluginName
Bundle-SymbolicName: org.eclipse.equinox.p2.garbagecollector;singleton:=true
Bundle-Version: 1.3.300.qualifier
Bundle-Version: 1.3.400.qualifier
Bundle-Vendor: %providerName
Bundle-Localization: plugin
Export-Package: org.eclipse.equinox.internal.p2.garbagecollector;x-friends:="org.eclipse.equinox.p2.touchpoint.eclipse,org.eclipse.pde.core,org.eclipse.equinox.p2.ui.sdk.scheduler"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,11 @@
import org.eclipse.equinox.p2.repository.artifact.IArtifactRepository;

/**
* Any class which declares itself as an extension to the <tt>org.eclipse.equinox.p2.garbagecollector.marksetproviders</tt>
* extension point must extend this base class. Given a Profile, implementors are required
* to provide an array of MarkSet objects, each of which must contain an IArtifactRepository
* and the IArtifactKeys used by the given Profile.
* Any class which declares itself as an extension to the
* {@code org.eclipse.equinox.p2.garbagecollector.marksetproviders} extension
* point must extend this base class. Given a Profile, implementors are required
* to provide an array of MarkSet objects, each of which must contain an
* IArtifactRepository and the IArtifactKeys used by the given Profile.
*/
public abstract class MarkSetProvider {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Manifest-Version: 1.0
Bundle-ManifestVersion: 2
Bundle-Name: %pluginName
Bundle-SymbolicName: org.eclipse.equinox.p2.metadata;singleton:=true
Bundle-Version: 2.9.100.qualifier
Bundle-Version: 2.9.200.qualifier
Bundle-Vendor: %providerName
Bundle-Localization: plugin
Export-Package: org.eclipse.equinox.internal.p2.metadata;
Expand Down
Loading

0 comments on commit ad97cb5

Please sign in to comment.