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 596d9ab
Show file tree
Hide file tree
Showing 10 changed files with 35 additions and 29 deletions.
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: %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: %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: %bundleName
Bundle-SymbolicName: org.eclipse.equinox.p2.publisher;singleton:=true
Bundle-Version: 1.9.200.qualifier
Bundle-Version: 1.9.300.qualifier
Bundle-Activator: org.eclipse.equinox.internal.p2.publisher.Activator
Bundle-Vendor: %providerName
Bundle-Localization: plugin
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,17 +52,22 @@ public class AdviceFileAdvice extends AbstractAdvice implements ITouchpointAdvic
private boolean containsAdvice = false;

/**
* Creates advice for an advice file at the given location. If <tt>basePath</tt>
* is a directory, then <tt>adviceFilePath</tt> is appended to this location to
* obtain the location of the advice file. If <tt>basePath</tt> is a file, then
* <tt>adviceFilePath</tt> is used to
* @param id The symbolic id of the installable unit this advice applies to
* @param version The version of the installable unit this advice applies to
* @param basePath The root location of the the advice file. This is either the location of
* the jar containing the advice, or a directory containing the advice file
* @param adviceFilePath The location of the advice file within the base path. This is
* either the path of a jar entry, or the path of the advice file within the directory
* specified by the base path.
* Creates advice for an advice file at the given location. If {@code basePath}
* is a directory, then {@code adviceFilePath} is appended to this location to
* obtain the location of the advice file. If {@code basePath} is a file, then
* {@code adviceFilePath} is used to
*
* @param id The symbolic id of the installable unit this advice
* applies to
* @param version The version of the installable unit this advice applies
* to
* @param basePath The root location of the the advice file. This is
* either the location of the jar containing the advice,
* or a directory containing the advice file
* @param adviceFilePath The location of the advice file within the base path.
* This is either the path of a jar entry, or the path of
* the advice file within the directory specified by the
* base path.
*/
public AdviceFileAdvice(String id, Version version, IPath basePath, IPath adviceFilePath) {
Assert.isNotNull(id);
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.tests.discovery;singleton:=true
Bundle-Version: 1.4.500.qualifier
Bundle-Version: 1.4.600.qualifier
Bundle-Vendor: %Bundle-Vendor
Bundle-Localization: plugin
Export-Package: org.eclipse.equinox.p2.discovery.tests;x-internal:=true,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,11 @@
public abstract class DiscoveryTestConstants {

/**
* The URL of the mylyn discovery directory, may be overridden using the system property
* <tt>mylyn.discovery.directory</tt>.
* The URL of the mylyn discovery directory, may be overridden using the system
* property {@code mylyn.discovery.directory}.
*/
public static final String DISCOVERY_URL = System.getProperty("mylyn.discovery.directory", "http://www.eclipse.org/mylyn/discovery/directory-3.3.xml"); //$NON-NLS-1$ //$NON-NLS-2$
public static final String DISCOVERY_URL = System.getProperty("mylyn.discovery.directory", //$NON-NLS-1$
"http://www.eclipse.org/mylyn/discovery/directory-3.3.xml"); //$NON-NLS-1$

private DiscoveryTestConstants() {
// don't allow clients to instantiate
Expand Down

0 comments on commit 596d9ab

Please sign in to comment.