Javadoc changes
diff --git a/bundles/org.eclipse.core.expressions/src/org/eclipse/core/expressions/ElementHandler.java b/bundles/org.eclipse.core.expressions/src/org/eclipse/core/expressions/ElementHandler.java
index 9e45594..3ec1dd1 100644
--- a/bundles/org.eclipse.core.expressions/src/org/eclipse/core/expressions/ElementHandler.java
+++ b/bundles/org.eclipse.core.expressions/src/org/eclipse/core/expressions/ElementHandler.java
@@ -18,10 +18,8 @@
/**
- * An element handler converts a {@link IConfigurationElement} into a
- * corresponding expression object. If the configuration element represents
- * a composite expression (like and, or, adapt, ...) then the method <code>
- * processChildren</code> should be used to convert the children as well.
+ * An element handler converts an {@link IConfigurationElement} into a
+ * corresponding expression object.
* <p>
* The class should be subclassed by clients wishing to provide an element
* handler for special expressions.
@@ -59,7 +57,9 @@
/**
* Converts the children of the given configuration element and adds them
* to the given composite expression.
- *
+ * <p>
+ * Note this is an internal method and should not be called by clients.
+ * </p>
* @param converter the converter used to do the actual conversion
* @param element the configuration element for which the children
* are to be processed
diff --git a/bundles/org.eclipse.core.expressions/src/org/eclipse/core/expressions/EvaluationResult.java b/bundles/org.eclipse.core.expressions/src/org/eclipse/core/expressions/EvaluationResult.java
index b875b6f..cf103b6 100644
--- a/bundles/org.eclipse.core.expressions/src/org/eclipse/core/expressions/EvaluationResult.java
+++ b/bundles/org.eclipse.core.expressions/src/org/eclipse/core/expressions/EvaluationResult.java
@@ -24,7 +24,16 @@
* </code>, <code>or</code> and <code>not</code>. The operation are
* defined as follows:
* </p>
+ * <p>
+ * The and operation:
+ * </p>
* <table border="1" cellpadding="5">
+ * <colgroup>
+ * <col width="120">
+ * <col width="120">
+ * <col width="120">
+ * <col width="120">
+ * </colgroup>
* <tbody>
* <tr>
* <td><em>AND</em></td>
@@ -52,7 +61,16 @@
* </tr>
* </tbody>
* </table>
+ * <p>
+ * The or operation:
+ * </p>
* <table border="1" cellpadding="5">
+ * <colgroup>
+ * <col width="120">
+ * <col width="120">
+ * <col width="120">
+ * <col width="120">
+ * </colgroup>
* <tbody>
* <tr>
* <td><em>OR</em></td>
@@ -80,7 +98,16 @@
* </tr>
* </tbody>
* </table>
+ * <p>
+ * The not operation:
+ * </p>
* <table border="1" cellpadding="5">
+ * <colgroup>
+ * <col width="120">
+ * <col width="120">
+ * <col width="120">
+ * <col width="120">
+ * </colgroup>
* <tbody>
* <tr>
* <td><em>NOT<em></td>
@@ -177,7 +204,7 @@
/**
* Returns an evaluation result instance representing the
* given boolean value. If the given boolean value is
- * <code>true</code> then <code.ExpressionResult.TRUE<code>
+ * <code>true</code> then <code>ExpressionResult.TRUE</code>
* is returned. If the value is <code>false</code> then <code>
* ExpressionResult.FALSE</code> is returned.
*
@@ -193,7 +220,7 @@
/**
* Returns a evaluation result instance representing the
* given <code>Boolean</code> value. If the given <code>Boolean
- * </code> value is <code>true</code> then <code.ExpressionResult.TRUE<code>
+ * </code> value is <code>true</code> then <code>ExpressionResult.TRUE</code>
* is returned. If the value is <code>false</code> then <code>
* ExpressionResult.FALSE</code> is returned.
*
diff --git a/bundles/org.eclipse.core.expressions/src/org/eclipse/core/expressions/Expression.java b/bundles/org.eclipse.core.expressions/src/org/eclipse/core/expressions/Expression.java
index fcf2e56..320a857 100644
--- a/bundles/org.eclipse.core.expressions/src/org/eclipse/core/expressions/Expression.java
+++ b/bundles/org.eclipse.core.expressions/src/org/eclipse/core/expressions/Expression.java
@@ -53,7 +53,7 @@
/**
* Evaluates this expression.
*
- * @param context a evaluation context providing information like variable,
+ * @param context an evaluation context providing information like variable,
* name spaces, etc. necessary to evaluate this expression
*
* @return the result of the expression evaluation
diff --git a/bundles/org.eclipse.core.expressions/src/org/eclipse/core/expressions/ExpressionConverter.java b/bundles/org.eclipse.core.expressions/src/org/eclipse/core/expressions/ExpressionConverter.java
index 9517ad9..dbcd0db 100644
--- a/bundles/org.eclipse.core.expressions/src/org/eclipse/core/expressions/ExpressionConverter.java
+++ b/bundles/org.eclipse.core.expressions/src/org/eclipse/core/expressions/ExpressionConverter.java
@@ -21,7 +21,7 @@
import org.eclipse.core.internal.expressions.ExpressionPlugin;
/**
- * An expression converter converts an XML expression represented by a
+ * An expression converter converts an XML expression represented by an
* {@link IConfigurationElement} tree into a corresponding expression tree.
*
* <p>
diff --git a/bundles/org.eclipse.core.expressions/src/org/eclipse/core/expressions/IEvaluationContext.java b/bundles/org.eclipse.core.expressions/src/org/eclipse/core/expressions/IEvaluationContext.java
index c2b71e2..5342fdf 100644
--- a/bundles/org.eclipse.core.expressions/src/org/eclipse/core/expressions/IEvaluationContext.java
+++ b/bundles/org.eclipse.core.expressions/src/org/eclipse/core/expressions/IEvaluationContext.java
@@ -13,7 +13,7 @@
import org.eclipse.core.runtime.CoreException;
/**
- * A evaluation context is used to manage a set of objects needed during
+ * An evaluation context is used to manage a set of objects needed during
* XML expression evaluation. A context has a parent context, can manage
* a set of named variables and has a default variable. The default variable
* is used during XML expression evaluation if no explicit variable is
@@ -74,7 +74,8 @@
* Returns the variable managed under the given name.
*
* @param name the variable's name
- * @return the variable's value
+ * @return the variable's value or <code>null</code> if the content
+ * doesn't manage a variable with the given name
*/
public Object getVariable(String name);
@@ -87,7 +88,8 @@
* @param name the variable to resolve
* @param args an object array of arguments used to resolve the
* variable
- * @return the variable's value
+ * @return the variable's value or <code>null</code> if no variable
+ * can be resolved for the given name and arguments
* @exception CoreException if an errors occurs while resolving
* the variable
*/
diff --git a/bundles/org.eclipse.core.expressions/src/org/eclipse/core/expressions/IPropertyTester.java b/bundles/org.eclipse.core.expressions/src/org/eclipse/core/expressions/IPropertyTester.java
index fed8d1c..86eded4 100644
--- a/bundles/org.eclipse.core.expressions/src/org/eclipse/core/expressions/IPropertyTester.java
+++ b/bundles/org.eclipse.core.expressions/src/org/eclipse/core/expressions/IPropertyTester.java
@@ -68,7 +68,7 @@
*
* @param receiver the receiver of the property test
* @param property the property to test
- * @param args additional arguments to resolve the property. If no arguments
+ * @param args additional arguments to evaluate the property. If no arguments
* are specified in the <code>test</code> expression an array of length 0
* is passed
* @param expectedValue the expected value of the property. The value is either
diff --git a/bundles/org.eclipse.core.expressions/src/org/eclipse/core/expressions/PropertyTester.java b/bundles/org.eclipse.core.expressions/src/org/eclipse/core/expressions/PropertyTester.java
index 014dd14..2c85ec5 100644
--- a/bundles/org.eclipse.core.expressions/src/org/eclipse/core/expressions/PropertyTester.java
+++ b/bundles/org.eclipse.core.expressions/src/org/eclipse/core/expressions/PropertyTester.java
@@ -25,13 +25,13 @@
* A property tester implements the property tests enumerated in the property
* tester extension point. For the following property test extension
* <pre>
- * <propertyTester
+ * <propertyTester
* namespace="org.eclipse.jdt.core"
* id="org.eclipse.jdt.core.IPackageFragmentTester"
* properties="isDefaultPackage"
* type="org.eclipse.jdt.core.IPackageFragment"
- * class="org.eclipse.demo.MyPackageFragmentTester">
- * </propertyTester>
+ * class="org.eclipse.demo.MyPackageFragmentTester">
+ * </propertyTester>
* </pre>
* the corresponding implemenation class looks like:
* <pre>
@@ -48,8 +48,8 @@
* </pre>
* The property can then be used in a test expression as follows:
* <pre>
- * <instanceof value="org.eclipse.core.IPackageFragment"/>
- * <test property="org.eclipse.jdt.core.isDefaultPackage"/>
+ * <instanceof value="org.eclipse.core.IPackageFragment"/>
+ * <test property="org.eclipse.jdt.core.isDefaultPackage"/>
* </pre>
* </p>
* @since 3.0
@@ -63,7 +63,7 @@
/**
* Initialize the property tester with the given name space and property.
* <p>
- * Note: this method is for internal use only. Clients msut not call
+ * Note: this method is for internal use only. Clients must not call
* this method.
* </p>
* @param descriptor the descriptor object for this tester
diff --git a/bundles/org.eclipse.core.expressions/src/org/eclipse/core/expressions/package.html b/bundles/org.eclipse.core.expressions/src/org/eclipse/core/expressions/package.html
index 2fe80c4..6ca3c11 100644
--- a/bundles/org.eclipse.core.expressions/src/org/eclipse/core/expressions/package.html
+++ b/bundles/org.eclipse.core.expressions/src/org/eclipse/core/expressions/package.html
@@ -221,10 +221,13 @@
<p><u><i>Extension Point Schema</i></u></p>
<p>An extension point schema exists for the property tester extension
-point, but not yet for the common expression language itself. The
-problem is that schemas can't be included across plug-ins. This
-limitation will be resolved by the PDE team and as soon as this is
-possible a corresponding schema file will be provided.</p>
+point and for the expression language itself. The schema for the
+expression language can be included into other schema files using
+the following include element:
+</p>
+<blockquote><pre>
+<include schemaLocation="schema://org.eclipse.core.expressions/schema/expressionLanguage.exsd"/>
+</pre></blockquote>
<p><a name="converting"><u><i>Converting XML elements into expressions</i></u></a></p>
<p>XML elements con be converted into corresponding expression objects using the class ExpressionConverter. If only expression tags from the common expression language are used then the standard expression converter can be used. The following example converts the configuration element representing an enablement element into the expressions:</p>
<blockquote>
@@ -233,7 +236,12 @@
ExpressionConverter.getDefault().perform(enablementElement);</code></p>
</blockquote>
<p><i><u>Evaluating an expression</u></i></p>
-<p>Expressions are evaluated by calling <code>Expression.evaluate(...);</code>. The evaluation context passed to the evaluate method has to be set up by the plug-in that reads an extension point. The plug-in is responsible to set up the default variable and all the other variable used in with expressions. If dynamic resolving of variables is supported by the plug-in providing the extension point then a sub class of evaluation context must provide a matching resolveVariable implementation. The example below creates a special evaluation context and uses this context to evaluate an expression:</p><blockquote>
+<p>Expressions are evaluated by calling <code>Expression.evaluate(...);</code>. The evaluation
+context passed to the evaluate method has to be set up by the plug-in that reads an extension point.
+The plug-in is responsible to set up the default variable and all the other variable used in
+with expressions. The example below creates a special evaluation context and uses this context to
+evaluate an expression:
+</p><blockquote>
<pre>
<code>
EvaluationContext context= new EvaluationContext(null, defaultVariable) {
