Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat (limited to 'bundles/org.eclipse.equinox.p2.metadata/src/org/eclipse/equinox/p2/metadata')
-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
3 files changed, 19 insertions, 19 deletions
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);
}

Back to the top