Skip to main content
summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDarin Wright2004-04-14 20:31:31 +0000
committerDarin Wright2004-04-14 20:31:31 +0000
commit799d33046bd927883916df65a80ddb014f9a16f8 (patch)
treef9733476c1fe1453765a94badb8b31e8e82d5356 /org.eclipse.core.variables
parentaaa687f45a73e4a90dca5fdecdf2a602be1ef63b (diff)
downloadeclipse.platform.debug-799d33046bd927883916df65a80ddb014f9a16f8.tar.gz
eclipse.platform.debug-799d33046bd927883916df65a80ddb014f9a16f8.tar.xz
eclipse.platform.debug-799d33046bd927883916df65a80ddb014f9a16f8.zip
javadoc
Diffstat (limited to 'org.eclipse.core.variables')
-rw-r--r--org.eclipse.core.variables/src/org/eclipse/core/variables/IDynamicVariable.java13
-rw-r--r--org.eclipse.core.variables/src/org/eclipse/core/variables/IValueVariable.java27
-rw-r--r--org.eclipse.core.variables/src/org/eclipse/core/variables/IValueVariableListener.java2
3 files changed, 20 insertions, 22 deletions
diff --git a/org.eclipse.core.variables/src/org/eclipse/core/variables/IDynamicVariable.java b/org.eclipse.core.variables/src/org/eclipse/core/variables/IDynamicVariable.java
index 6138878de..a78704bf1 100644
--- a/org.eclipse.core.variables/src/org/eclipse/core/variables/IDynamicVariable.java
+++ b/org.eclipse.core.variables/src/org/eclipse/core/variables/IDynamicVariable.java
@@ -16,17 +16,18 @@ import org.eclipse.core.runtime.CoreException;
* A dynamic variable is a variable whose value is computed dynamically
* by a resolver at the time a string substitution is performed. A dynamic
* variable is contributed by an extension.
- *
+ * <p>
* The following is a definition of a dynamic variable that resolves to the name of the selected resource:
* <pre>
- * <extension point="org.eclipse.core.variables.dynamicVariables">
- * <variable
+ * &lt;extension point="org.eclipse.core.variables.dynamicVariables"&gt;
+ * &lt;variable
* name="resource_name"
* expanderClass="com.example.ResourceNameExpander"
- * description="The name of the selected resource">
- * </variable>
- * </extension>
+ * description="The name of the selected resource"&gt;
+ * &lt;/variable&gt;
+ * &lt;/extension&gt;
* </pre>
+ * </p>
*
* @since 3.0
*/
diff --git a/org.eclipse.core.variables/src/org/eclipse/core/variables/IValueVariable.java b/org.eclipse.core.variables/src/org/eclipse/core/variables/IValueVariable.java
index 6e97cd181..6c1bd80e2 100644
--- a/org.eclipse.core.variables/src/org/eclipse/core/variables/IValueVariable.java
+++ b/org.eclipse.core.variables/src/org/eclipse/core/variables/IValueVariable.java
@@ -16,32 +16,29 @@ package org.eclipse.core.variables;
* A value variable can be contributed by an extension or created programmatically.
* A contributor may optionally specify an initial value for a variable, or
* provide a delegate that will initialie the variable with a value.
- *
+ * <p>
* Example of a value variable contribution with an initial value, the specified
* variable is created with the initial value "/usr/local/foo".
- *
- * <p>
* <pre>
- * <extension point="org.eclipse.core.variables.valueVariables">
- * <variable
+ * &lt;extension point="org.eclipse.core.variables.valueVariables"&gt;
+ * &lt;variable
* name="FOO_HOME"
- * initialValue="/usr/local/foo">
- * </variable>
- * </extension>
+ * initialValue="/usr/local/foo"&gt;
+ * &lt;/variable&gt;
+ * &lt;/extension&gt;
* </pre>
* </p>
- *
+ * <p>
* Example of a value variable contribution with an initializer class, the class
* "com.example.FooLocator" will be used to initialize the value the first time
* it's requested.
- * <p>
* <pre>
- * <extension point="org.eclipse.core.variables.valueVariables">
- * <variable
+ * &lt;extension point="org.eclipse.core.variables.valueVariables"&gt;
+ * &lt;variable
* name="FOO_HOME"
- * initializerClass="com.example.FooLocator">
- * </variable>
- * </extension>
+ * initializerClass="com.example.FooLocator"&gt;
+ * &lt;/variable&gt;
+ * &lt;/extension&gt;
* </pre>
* </p>
*
diff --git a/org.eclipse.core.variables/src/org/eclipse/core/variables/IValueVariableListener.java b/org.eclipse.core.variables/src/org/eclipse/core/variables/IValueVariableListener.java
index 10a26f82e..87c018a49 100644
--- a/org.eclipse.core.variables/src/org/eclipse/core/variables/IValueVariableListener.java
+++ b/org.eclipse.core.variables/src/org/eclipse/core/variables/IValueVariableListener.java
@@ -15,7 +15,7 @@ package org.eclipse.core.variables;
* and removed from the string variable manager. As well, listeners are
* notified when a value variable changes value.
*
- * since 3.0
+ * @since 3.0
*/
public interface IValueVariableListener {

Back to the top