Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAndrew Gvozdev2013-03-11 01:03:15 +0000
committerAndrew Gvozdev2013-03-11 13:27:44 +0000
commit147e2efc706ef7459d605bca8fe9f7499b07ea91 (patch)
treeee77b09525b76cbbeb3c1bdc1b1a7c6b56ff4b8e
parent338da6c867ecc26e44be1f125ddae7117205450e (diff)
downloadorg.eclipse.cdt-147e2efc706ef7459d605bca8fe9f7499b07ea91.tar.gz
org.eclipse.cdt-147e2efc706ef7459d605bca8fe9f7499b07ea91.tar.xz
org.eclipse.cdt-147e2efc706ef7459d605bca8fe9f7499b07ea91.zip
Some JavaDoc for Build Variables change listeners
-rw-r--r--core/org.eclipse.cdt.core/src/org/eclipse/cdt/internal/core/cdtvariables/ICdtVariableChangeListener.java3
-rw-r--r--core/org.eclipse.cdt.core/src/org/eclipse/cdt/internal/core/cdtvariables/UserDefinedVariableSupplier.java10
-rw-r--r--core/org.eclipse.cdt.core/src/org/eclipse/cdt/internal/core/cdtvariables/VariableChangeEvent.java3
3 files changed, 16 insertions, 0 deletions
diff --git a/core/org.eclipse.cdt.core/src/org/eclipse/cdt/internal/core/cdtvariables/ICdtVariableChangeListener.java b/core/org.eclipse.cdt.core/src/org/eclipse/cdt/internal/core/cdtvariables/ICdtVariableChangeListener.java
index 79740cd4bef..eda0e2096d4 100644
--- a/core/org.eclipse.cdt.core/src/org/eclipse/cdt/internal/core/cdtvariables/ICdtVariableChangeListener.java
+++ b/core/org.eclipse.cdt.core/src/org/eclipse/cdt/internal/core/cdtvariables/ICdtVariableChangeListener.java
@@ -10,6 +10,9 @@
*******************************************************************************/
package org.eclipse.cdt.internal.core.cdtvariables;
+/**
+ * Listener to listen to Build Variables changes events.
+ */
public interface ICdtVariableChangeListener {
void variablesChanged(VariableChangeEvent event);
}
diff --git a/core/org.eclipse.cdt.core/src/org/eclipse/cdt/internal/core/cdtvariables/UserDefinedVariableSupplier.java b/core/org.eclipse.cdt.core/src/org/eclipse/cdt/internal/core/cdtvariables/UserDefinedVariableSupplier.java
index b823a917e0a..c098d01fba3 100644
--- a/core/org.eclipse.cdt.core/src/org/eclipse/cdt/internal/core/cdtvariables/UserDefinedVariableSupplier.java
+++ b/core/org.eclipse.cdt.core/src/org/eclipse/cdt/internal/core/cdtvariables/UserDefinedVariableSupplier.java
@@ -651,10 +651,20 @@ public class UserDefinedVariableSupplier extends CoreMacroSupplierBase {
// protected void updateProjectInfo(int type, Object context){
// }
+ /**
+ * Adds a listener that will be notified of changes in Build Variables.
+ *
+ * @param listener - the listener to add
+ */
public void addListener(ICdtVariableChangeListener listener){
fListeners.add(listener);
}
+ /**
+ * Removes a Build Variables change listener.
+ *
+ * @param listener - the listener to remove.
+ */
public void removeListener(ICdtVariableChangeListener listener){
fListeners.remove(listener);
}
diff --git a/core/org.eclipse.cdt.core/src/org/eclipse/cdt/internal/core/cdtvariables/VariableChangeEvent.java b/core/org.eclipse.cdt.core/src/org/eclipse/cdt/internal/core/cdtvariables/VariableChangeEvent.java
index e42425b2ada..fbf7db1dd2c 100644
--- a/core/org.eclipse.cdt.core/src/org/eclipse/cdt/internal/core/cdtvariables/VariableChangeEvent.java
+++ b/core/org.eclipse.cdt.core/src/org/eclipse/cdt/internal/core/cdtvariables/VariableChangeEvent.java
@@ -12,6 +12,9 @@ package org.eclipse.cdt.internal.core.cdtvariables;
import org.eclipse.cdt.core.cdtvariables.ICdtVariable;
+/**
+ * Event describing Build Variables changes.
+ */
public class VariableChangeEvent {
private static final ICdtVariable[] EMPTY_VAR_ARRAY = new ICdtVariable[0];

Back to the top