Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlexander Kurtakov2019-03-18 08:55:29 -0400
committerAlexander Kurtakov2019-03-18 09:20:28 -0400
commitf8826cbd2118a82aa411e3618be87949383b703e (patch)
tree0acd7a70af24b9af7be5320041655c25826cf3da
parent0195c97ec53875f5d39ed0903feccefe5b1ac3b4 (diff)
downloadrt.equinox.p2-I20190325-0105.tar.gz
rt.equinox.p2-I20190325-0105.tar.xz
rt.equinox.p2-I20190325-0105.zip
Fix p2 javadoc warnings. Change-Id: I4f9cd9c79917a70f9b69e75557d6a137cfaa1473 Signed-off-by: Alexander Kurtakov <akurtako@redhat.com>
-rw-r--r--bundles/org.eclipse.equinox.frameworkadmin/META-INF/MANIFEST.MF2
-rw-r--r--bundles/org.eclipse.equinox.frameworkadmin/pom.xml2
-rw-r--r--bundles/org.eclipse.equinox.frameworkadmin/src/org/eclipse/equinox/frameworkadmin/BundleInfo.java12
-rw-r--r--bundles/org.eclipse.equinox.p2.engine/META-INF/MANIFEST.MF2
-rw-r--r--bundles/org.eclipse.equinox.p2.engine/pom.xml2
-rw-r--r--bundles/org.eclipse.equinox.p2.engine/src/org/eclipse/equinox/p2/engine/IProfile.java4
-rw-r--r--bundles/org.eclipse.equinox.p2.metadata/META-INF/MANIFEST.MF2
-rw-r--r--bundles/org.eclipse.equinox.p2.metadata/pom.xml2
-rw-r--r--bundles/org.eclipse.equinox.p2.metadata/src/org/eclipse/equinox/p2/metadata/MetadataFactory.java31
-rw-r--r--bundles/org.eclipse.equinox.p2.metadata/src/org/eclipse/equinox/p2/metadata/expression/IExpressionFactory.java2
-rw-r--r--bundles/org.eclipse.equinox.p2.metadata/src/org/eclipse/equinox/p2/metadata/expression/IExpressionParser.java5
-rw-r--r--bundles/org.eclipse.equinox.p2.metadata/src/org/eclipse/equinox/p2/query/QueryUtil.java6
-rw-r--r--bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/ICompositeRepository.java2
-rw-r--r--bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/artifact/IArtifactRepository.java12
-rw-r--r--bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/artifact/spi/ProcessingStepDescriptor.java8
15 files changed, 53 insertions, 41 deletions
diff --git a/bundles/org.eclipse.equinox.frameworkadmin/META-INF/MANIFEST.MF b/bundles/org.eclipse.equinox.frameworkadmin/META-INF/MANIFEST.MF
index 67f411158..5e44cce9f 100644
--- a/bundles/org.eclipse.equinox.frameworkadmin/META-INF/MANIFEST.MF
+++ b/bundles/org.eclipse.equinox.frameworkadmin/META-INF/MANIFEST.MF
@@ -2,7 +2,7 @@ Manifest-Version: 1.0
Bundle-ManifestVersion: 2
Bundle-Name: %pluginName
Bundle-SymbolicName: org.eclipse.equinox.frameworkadmin;singleton:=true
-Bundle-Version: 2.1.200.qualifier
+Bundle-Version: 2.1.300.qualifier
Bundle-Vendor: %providerName
Bundle-Localization: plugin
Import-Package: org.eclipse.osgi.service.pluginconversion;version="1.0.0",
diff --git a/bundles/org.eclipse.equinox.frameworkadmin/pom.xml b/bundles/org.eclipse.equinox.frameworkadmin/pom.xml
index 0a2035faa..31b9ad959 100644
--- a/bundles/org.eclipse.equinox.frameworkadmin/pom.xml
+++ b/bundles/org.eclipse.equinox.frameworkadmin/pom.xml
@@ -9,6 +9,6 @@
</parent>
<groupId>org.eclipse.equinox</groupId>
<artifactId>org.eclipse.equinox.frameworkadmin</artifactId>
- <version>2.1.200-SNAPSHOT</version>
+ <version>2.1.300-SNAPSHOT</version>
<packaging>eclipse-plugin</packaging>
</project>
diff --git a/bundles/org.eclipse.equinox.frameworkadmin/src/org/eclipse/equinox/frameworkadmin/BundleInfo.java b/bundles/org.eclipse.equinox.frameworkadmin/src/org/eclipse/equinox/frameworkadmin/BundleInfo.java
index 6e9db6268..9c7ab6467 100644
--- a/bundles/org.eclipse.equinox.frameworkadmin/src/org/eclipse/equinox/frameworkadmin/BundleInfo.java
+++ b/bundles/org.eclipse.equinox.frameworkadmin/src/org/eclipse/equinox/frameworkadmin/BundleInfo.java
@@ -192,9 +192,10 @@ public class BundleInfo {
}
/**
- * Set the bundle id
+ * Set the bundle id.
*
* @param bundleId
+ * The bundle id.
*/
public void setBundleId(long bundleId) {
this.bundleId = bundleId;
@@ -215,6 +216,7 @@ public class BundleInfo {
* Set the location for this bundle.
*
* @param location
+ * The location of the bundle.
*/
public void setLocation(URI location) {
this.location = location;
@@ -224,6 +226,7 @@ public class BundleInfo {
* Set the manifest for this bundle
*
* @param manifest
+ * The manifest.
*/
public void setManifest(String manifest) {
this.manifest = manifest;
@@ -233,6 +236,7 @@ public class BundleInfo {
* Set whether or not this bundle should be started
*
* @param markedAsStarted
+ * Whether the bundle should be started.
*/
public void setMarkedAsStarted(boolean markedAsStarted) {
this.markedAsStarted = markedAsStarted;
@@ -242,6 +246,7 @@ public class BundleInfo {
* Set whether or not the bundle is resolved
*
* @param resolved
+ * If the bundle is resolved or not.
*/
public void setResolved(boolean resolved) {
this.resolved = resolved;
@@ -251,7 +256,7 @@ public class BundleInfo {
* Set the start level.
*
* @param level
- * if a value < 0 is passed, the start level will be set to
+ * if a value &lt; 0 is passed, the start level will be set to
* {@link #NO_LEVEL}
*/
public void setStartLevel(int level) {
@@ -262,6 +267,7 @@ public class BundleInfo {
* Set the Bundle-SymbolicName
*
* @param symbolicName
+ * The Bundle-SymbolicName.
*/
public void setSymbolicName(String symbolicName) {
this.symbolicName = symbolicName;
@@ -271,6 +277,7 @@ public class BundleInfo {
* Set the version, should be a valid {@link Version} string
*
* @param value
+ * The version. A valid {@link Version} string.
*/
public void setVersion(String value) {
if (value == null)
@@ -283,6 +290,7 @@ public class BundleInfo {
* Set the host if this bundle is a fragment
*
* @param fragmentHost
+ * The host for this fragment.
*/
public void setFragmentHost(String fragmentHost) {
this.fragmentHost = fragmentHost;
diff --git a/bundles/org.eclipse.equinox.p2.engine/META-INF/MANIFEST.MF b/bundles/org.eclipse.equinox.p2.engine/META-INF/MANIFEST.MF
index 2f9e5fa5e..4599ca202 100644
--- a/bundles/org.eclipse.equinox.p2.engine/META-INF/MANIFEST.MF
+++ b/bundles/org.eclipse.equinox.p2.engine/META-INF/MANIFEST.MF
@@ -2,7 +2,7 @@ Manifest-Version: 1.0
Bundle-ManifestVersion: 2
Bundle-Name: %pluginName
Bundle-SymbolicName: org.eclipse.equinox.p2.engine;singleton:=true
-Bundle-Version: 2.6.200.qualifier
+Bundle-Version: 2.6.300.qualifier
Bundle-Activator: org.eclipse.equinox.internal.p2.engine.EngineActivator
Bundle-Vendor: %providerName
Bundle-Localization: plugin
diff --git a/bundles/org.eclipse.equinox.p2.engine/pom.xml b/bundles/org.eclipse.equinox.p2.engine/pom.xml
index 614350e6b..5a260334e 100644
--- a/bundles/org.eclipse.equinox.p2.engine/pom.xml
+++ b/bundles/org.eclipse.equinox.p2.engine/pom.xml
@@ -9,6 +9,6 @@
</parent>
<groupId>org.eclipse.equinox</groupId>
<artifactId>org.eclipse.equinox.p2.engine</artifactId>
- <version>2.6.200-SNAPSHOT</version>
+ <version>2.6.300-SNAPSHOT</version>
<packaging>eclipse-plugin</packaging>
</project>
diff --git a/bundles/org.eclipse.equinox.p2.engine/src/org/eclipse/equinox/p2/engine/IProfile.java b/bundles/org.eclipse.equinox.p2.engine/src/org/eclipse/equinox/p2/engine/IProfile.java
index 26e62a713..c0d8fec1b 100644
--- a/bundles/org.eclipse.equinox.p2.engine/src/org/eclipse/equinox/p2/engine/IProfile.java
+++ b/bundles/org.eclipse.equinox.p2.engine/src/org/eclipse/equinox/p2/engine/IProfile.java
@@ -173,7 +173,7 @@ public interface IProfile extends IQueryable<IInstallableUnit> {
public static final String STATE_SHARED_INSTALL_VALUE_NEW = "new"; //$NON-NLS-1$
/**
- * Profile property constant for additional parameters of the downloading stats(e.g., package=jee&os=linux).
+ * Profile property constant for additional parameters of the downloading stats(e.g., package=jee&amp;os=linux).
* @since 2.2
*/
public static final String PROP_STATS_PARAMETERS = "org.eclipse.equinox.p2.stats.parameters"; //$NON-NLS-1$
@@ -230,7 +230,7 @@ public interface IProfile extends IQueryable<IInstallableUnit> {
* Returns the installable units in this profile that match the given query. In a shared
* install, this will include both the installable units in the shared base location, and in
* the current user's private install area.
- * @param query
+ * @param query The query to use for matching.
* @param monitor a progress monitor, or <code>null</code> if progress
* reporting is not desired
* @return The installable units that match the given query
diff --git a/bundles/org.eclipse.equinox.p2.metadata/META-INF/MANIFEST.MF b/bundles/org.eclipse.equinox.p2.metadata/META-INF/MANIFEST.MF
index 4ac2b1ea3..b5eeab26e 100644
--- a/bundles/org.eclipse.equinox.p2.metadata/META-INF/MANIFEST.MF
+++ b/bundles/org.eclipse.equinox.p2.metadata/META-INF/MANIFEST.MF
@@ -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.4.300.qualifier
+Bundle-Version: 2.4.400.qualifier
Bundle-Vendor: %providerName
Bundle-Localization: plugin
Export-Package: org.eclipse.equinox.internal.p2.metadata;
diff --git a/bundles/org.eclipse.equinox.p2.metadata/pom.xml b/bundles/org.eclipse.equinox.p2.metadata/pom.xml
index 2fbed9b3e..9c3f3fbdf 100644
--- a/bundles/org.eclipse.equinox.p2.metadata/pom.xml
+++ b/bundles/org.eclipse.equinox.p2.metadata/pom.xml
@@ -9,6 +9,6 @@
</parent>
<groupId>org.eclipse.equinox</groupId>
<artifactId>org.eclipse.equinox.p2.metadata</artifactId>
- <version>2.4.300-SNAPSHOT</version>
+ <version>2.4.400-SNAPSHOT</version>
<packaging>eclipse-plugin</packaging>
</project>
diff --git a/bundles/org.eclipse.equinox.p2.metadata/src/org/eclipse/equinox/p2/metadata/MetadataFactory.java b/bundles/org.eclipse.equinox.p2.metadata/src/org/eclipse/equinox/p2/metadata/MetadataFactory.java
index 81df102f6..3f4b5d6b2 100644
--- a/bundles/org.eclipse.equinox.p2.metadata/src/org/eclipse/equinox/p2/metadata/MetadataFactory.java
+++ b/bundles/org.eclipse.equinox.p2.metadata/src/org/eclipse/equinox/p2/metadata/MetadataFactory.java
@@ -548,12 +548,12 @@ public final class MetadataFactory {
/**
*
- * @param namespace
+ * @param namespace the namespace for the requirement. Must not be <code>null</code>.
* @param propsFilter filter applied on {@link IProvidedCapability#getProperties()} of every {@link IInstallableUnit#getProvidedCapabilities()}
* @param envFilter matcher over {@link IInstallableUnit#getProperties()}
- * @param minCard
- * @param maxCard
- * @param greedy
+ * @param minCard minimum cardinality
+ * @param maxCard maximum cardinality
+ * @param greedy <code>true</code> if the requirement should be considered greedy and <code>false</code> otherwise
* @return the requirement
* @since 2.4
*/
@@ -564,13 +564,13 @@ public final class MetadataFactory {
/**
*
- * @param namespace
- * @param propsFilter
- * @param envFilter
- * @param minCard
- * @param maxCard
- * @param greedy
- * @param description
+ * @param namespace the namespace for the requirement. Must not be <code>null</code>.
+ * @param propsFilter filter applied on {@link IProvidedCapability#getProperties()} of every {@link IInstallableUnit#getProvidedCapabilities()}
+ * @param envFilter matcher over {@link IInstallableUnit#getProperties()}
+ * @param minCard minimum cardinality
+ * @param maxCard maximum cardinality
+ * @param greedy <code>true</code> if the requirement should be considered greedy and <code>false</code> otherwise
+ * @param description a <code>String</code> description of the requirement, or <code>null</code>
* @return the requirement
* @since 2.4
*/
@@ -757,10 +757,11 @@ public final class MetadataFactory {
/**
*
- * @param descriptors
- * @param severity
- * @param description
- * @param location
+ * @param descriptors The IUs that the descriptor provides updates for.
+ * @param severity The update severity (either {@link IUpdateDescriptor#NORMAL}
+ * or {@link IUpdateDescriptor#HIGH})
+ * @param description A description of the update
+ * @param location a {@link URI} specifying the location or <code>null</code>
* @return A new update descriptor
*/
public static IUpdateDescriptor createUpdateDescriptor(Collection<IMatchExpression<IInstallableUnit>> descriptors, int severity, String description, URI location) {
diff --git a/bundles/org.eclipse.equinox.p2.metadata/src/org/eclipse/equinox/p2/metadata/expression/IExpressionFactory.java b/bundles/org.eclipse.equinox.p2.metadata/src/org/eclipse/equinox/p2/metadata/expression/IExpressionFactory.java
index cd4a2d4c4..4ec751c60 100644
--- a/bundles/org.eclipse.equinox.p2.metadata/src/org/eclipse/equinox/p2/metadata/expression/IExpressionFactory.java
+++ b/bundles/org.eclipse.equinox.p2.metadata/src/org/eclipse/equinox/p2/metadata/expression/IExpressionFactory.java
@@ -381,7 +381,7 @@ public interface IExpressionFactory {
/**
* Wrap an {@link IQuery} as an expression.
- * @param query
+ * @param query The query to wrap.
* @return An expression that wraps the query
*/
IExpression toExpression(IQuery<?> query);
diff --git a/bundles/org.eclipse.equinox.p2.metadata/src/org/eclipse/equinox/p2/metadata/expression/IExpressionParser.java b/bundles/org.eclipse.equinox.p2.metadata/src/org/eclipse/equinox/p2/metadata/expression/IExpressionParser.java
index 48a3bb332..4a84e1d96 100644
--- a/bundles/org.eclipse.equinox.p2.metadata/src/org/eclipse/equinox/p2/metadata/expression/IExpressionParser.java
+++ b/bundles/org.eclipse.equinox.p2.metadata/src/org/eclipse/equinox/p2/metadata/expression/IExpressionParser.java
@@ -13,7 +13,6 @@
*******************************************************************************/
package org.eclipse.equinox.p2.metadata.expression;
-
/**
* A parser that produces an expression tree based on a string representation. An
* implementation will use the {@link IExpressionFactory} to create the actual expressions
@@ -25,7 +24,7 @@ public interface IExpressionParser {
* variable 'this' and to the context parameters.
* @param exprString The string representing the boolean expression.
* @return The resulting expression tree.
- * @throws ExpressionParseException
+ * @throws ExpressionParseException If an error occurred during parsing.
*/
IExpression parse(String exprString);
@@ -34,7 +33,7 @@ public interface IExpressionParser {
* variable 'everything' and to the context parameters.
* @param exprString The string representing the boolean expression.
* @return The resulting expression tree.
- * @throws ExpressionParseException
+ * @throws ExpressionParseException If an error occurred during parsing.
*/
IExpression parseQuery(String exprString);
}
diff --git a/bundles/org.eclipse.equinox.p2.metadata/src/org/eclipse/equinox/p2/query/QueryUtil.java b/bundles/org.eclipse.equinox.p2.metadata/src/org/eclipse/equinox/p2/query/QueryUtil.java
index 679e63b3d..0a484b945 100644
--- a/bundles/org.eclipse.equinox.p2.metadata/src/org/eclipse/equinox/p2/query/QueryUtil.java
+++ b/bundles/org.eclipse.equinox.p2.metadata/src/org/eclipse/equinox/p2/query/QueryUtil.java
@@ -370,7 +370,7 @@ public class QueryUtil {
/**
* Creates an query that will iterate over all candidates and discriminate all
- * candidates that are not instances of <code>matchinClass></code> or for which
+ * candidates that are not instances of <code>matchingClass</code> or for which
* the boolean <code>matchExpression</code> returns false.
* @param matchingClass The class that matching candidates must be an instance of
* @param matchExpression The boolean expression used for filtering one candidate
@@ -384,8 +384,10 @@ public class QueryUtil {
/**
* Parses the <code>matchExpression</code> and creates an query that will iterate over
* all candidates and discriminate all candidates that are not instances of
- * <code>matchinClass></code> or for which the boolean <code>matchExpression</code>
+ * <code>matchingClass</code> or for which the boolean <code>matchExpression</code>
* returns false.
+ *
+ * @param <T> The type of input object that the created query accepts
* @param matchingClass The class that matching candidates must be an instance of
* @param matchExpression The boolean expression used for filtering one candidate
* @param parameters Values for parameter substitution
diff --git a/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/ICompositeRepository.java b/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/ICompositeRepository.java
index b70758307..a8cb4918e 100644
--- a/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/ICompositeRepository.java
+++ b/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/ICompositeRepository.java
@@ -35,7 +35,7 @@ public interface ICompositeRepository<T> extends IRepository<T> {
/**
* Adds a specified URI to list of child repositories.
* Does nothing if URI is a duplicate of an existing child repository.
- * @param child
+ * @param child The child to add.
*/
public void addChild(URI child);
diff --git a/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/artifact/IArtifactRepository.java b/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/artifact/IArtifactRepository.java
index 870e2eb27..f1b3b7f5d 100644
--- a/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/artifact/IArtifactRepository.java
+++ b/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/artifact/IArtifactRepository.java
@@ -59,9 +59,9 @@ public interface IArtifactRepository extends IRepository<IArtifactKey> {
/**
* Create an instance of {@link IArtifactKey}
- * @param classifier
- * @param id
- * @param version
+ * @param classifier The classifier for this artifact key.
+ * @param id The id for this artifact key.
+ * @param version The version for this artifact key.
* @return a new IArtifactKey
*/
public IArtifactKey createArtifactKey(String classifier, String id, Version version);
@@ -156,7 +156,7 @@ public interface IArtifactRepository extends IRepository<IArtifactKey> {
/**
* Executes the given artifact requests on this byte server.
* @param requests The artifact requests
- * @param monitor
+ * @param monitor A progress monitor use to track progress and cancel the operation.
* @return a status object that is <code>OK</code> if requests were
* processed successfully. Otherwise, a status indicating information,
* warnings, or errors that occurred while executing the artifact requests
@@ -256,7 +256,7 @@ public interface IArtifactRepository extends IRepository<IArtifactKey> {
/**
* Remove the given list of keys and all related content and descriptors from this
* repository.
- * @param keys
+ * @param keys The keys to remove.
* @since 2.1
* @deprecated See {@link #removeDescriptors(IArtifactKey[], IProgressMonitor)}
*/
@@ -266,7 +266,7 @@ public interface IArtifactRepository extends IRepository<IArtifactKey> {
/**
* Remove the given list of keys and all related content and descriptors from this
* repository.
- * @param keys
+ * @param keys The keys to remove.
* @param monitor A progress monitor use to track progress and cancel the operation. This may
* be a long running operation if another process holds the lock on this location
* @since 2.1
diff --git a/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/artifact/spi/ProcessingStepDescriptor.java b/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/artifact/spi/ProcessingStepDescriptor.java
index 66c75a0ef..e1a1b158a 100644
--- a/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/artifact/spi/ProcessingStepDescriptor.java
+++ b/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/artifact/spi/ProcessingStepDescriptor.java
@@ -27,9 +27,11 @@ public class ProcessingStepDescriptor implements IProcessingStepDescriptor {
/**
* Create a processing step description.
*
- * @param processorId
- * @param data
- * @param required
+ * @param processorId The fully qualified processing step extension id.
+ * @param data The processing step data. The structure
+ * and content of the data is specific to the particular processing step being used.
+ * @param required Whether the successful execution of this processing step is
+ * required for the transfer to be successful.
*/
public ProcessingStepDescriptor(String processorId, String data, boolean required) {
super();

Back to the top