Skip to main content
summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLuc Bourlier2003-10-27 20:19:40 +0000
committerLuc Bourlier2003-10-27 20:19:40 +0000
commit8d5da2751eb84388a594072fc1b2457d20c09c2d (patch)
tree001224ead595cb177d884d799ee399cb96772bd6 /org.eclipse.core.variables/src
parentfee69d380cdc7faaa048d3c70f97483ce90d7b57 (diff)
downloadeclipse.platform.debug-8d5da2751eb84388a594072fc1b2457d20c09c2d.tar.gz
eclipse.platform.debug-8d5da2751eb84388a594072fc1b2457d20c09c2d.tar.xz
eclipse.platform.debug-8d5da2751eb84388a594072fc1b2457d20c09c2d.zip
Bug 43332 - String Substitution Support - org.eclipse.core.variables
Diffstat (limited to 'org.eclipse.core.variables/src')
-rw-r--r--org.eclipse.core.variables/src/org/eclipse/core/variables/IDynamicVariable.java11
-rw-r--r--org.eclipse.core.variables/src/org/eclipse/core/variables/IValueVariable.java29
-rw-r--r--org.eclipse.core.variables/src/org/eclipse/core/variables/VariablesPlugin.java2
3 files changed, 38 insertions, 4 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 4e6789a8d..6138878de 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
@@ -17,7 +17,16 @@ import org.eclipse.core.runtime.CoreException;
* by a resolver at the time a string substitution is performed. A dynamic
* variable is contributed by an extension.
*
- * TODO: example extension
+ * 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
+ * name="resource_name"
+ * expanderClass="com.example.ResourceNameExpander"
+ * description="The name of the selected resource">
+ * </variable>
+ * </extension>
+ * </pre>
*
* @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 9ffed0fed..6e97cd181 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
@@ -17,7 +17,34 @@ package org.eclipse.core.variables;
* A contributor may optionally specify an initial value for a variable, or
* provide a delegate that will initialie the variable with a value.
*
- * TODO: example plug-in XML
+ * 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
+ * name="FOO_HOME"
+ * initialValue="/usr/local/foo">
+ * </variable>
+ * </extension>
+ * </pre>
+ * </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
+ * name="FOO_HOME"
+ * initializerClass="com.example.FooLocator">
+ * </variable>
+ * </extension>
+ * </pre>
+ * </p>
+ *
*
* @since 3.0
*/
diff --git a/org.eclipse.core.variables/src/org/eclipse/core/variables/VariablesPlugin.java b/org.eclipse.core.variables/src/org/eclipse/core/variables/VariablesPlugin.java
index 049764787..b1924f12d 100644
--- a/org.eclipse.core.variables/src/org/eclipse/core/variables/VariablesPlugin.java
+++ b/org.eclipse.core.variables/src/org/eclipse/core/variables/VariablesPlugin.java
@@ -88,7 +88,6 @@ public class VariablesPlugin extends Plugin {
* Logs the specified status with this plug-in's log.
*
* @param status status to log
- * @since 2.0
*/
public static void log(IStatus status) {
getDefault().getLog().log(status);
@@ -111,7 +110,6 @@ public class VariablesPlugin extends Plugin {
* Returns the string variable manager.
*
* @return the string variable manager
- * @since 3.0
*/
public IStringVariableManager getStringVariableManager() {
return StringVariableManager.getDefault();

Back to the top