Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichael Rennie2011-03-03 20:24:51 +0000
committerMichael Rennie2011-03-03 20:24:51 +0000
commitc36f5432343fdb7c9ff0e771e581736a20e38e7f (patch)
tree0efc5c8d5b839798668a02cabfe917e4c9c306ba
parentce8b939f07efe514ba844c68d0959e5bce498a6f (diff)
downloadeclipse.platform.debug-c36f5432343fdb7c9ff0e771e581736a20e38e7f.tar.gz
eclipse.platform.debug-c36f5432343fdb7c9ff0e771e581736a20e38e7f.tar.xz
eclipse.platform.debug-c36f5432343fdb7c9ff0e771e581736a20e38e7f.zip
[nobug] doc update for new API
-rw-r--r--org.eclipse.debug.ui/ui/org/eclipse/debug/ui/contexts/IDebugContextProvider2.java23
1 files changed, 17 insertions, 6 deletions
diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/ui/contexts/IDebugContextProvider2.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/ui/contexts/IDebugContextProvider2.java
index 7c093f306..88f4f89b6 100644
--- a/org.eclipse.debug.ui/ui/org/eclipse/debug/ui/contexts/IDebugContextProvider2.java
+++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/ui/contexts/IDebugContextProvider2.java
@@ -11,22 +11,33 @@
*****************************************************************/
package org.eclipse.debug.ui.contexts;
+import org.eclipse.ui.IWorkbenchPart;
+import org.eclipse.ui.IWorkbenchWindow;
+
+
/**
- * IDebugContextProvider extension.
+ * This extension to {@link IDebugContextProvider} allows clients to specify the scope that the context
+ * provider will apply to. With {@link IDebugContextProvider2}, a provider indicate if it should be a context
+ * provider for the entire {@link IWorkbenchWindow} or only for is given {@link IWorkbenchPart}.
+ *
+ * <p>
+ * This interface is intended to be implemented by clients
+ * </p>
*
* @since 3.7
*/
public interface IDebugContextProvider2 extends IDebugContextProvider {
/**
- * Return whether the provider can be set a an active provider for the
+ * Return whether the provider can be set as an active provider for the
* window.
* <p>
- * If <code>true</code> then upon the provider's part is
- * activation this provider will become the active debug context provider
- * for the whole window. If <code>false</code>, then this provider will
+ * If <code>true</code>, when the provider's part is
+ * activated this provider will become the active debug context provider
+ * for the whole window. If <code>false</code>, this provider will
* only set the active context in a given workbench part.
*
- * @return <code>true</code> if capable to be the active debug context
+ * @return <code>true</code> if this provider can act as the provider for the entire window, <code>false</code> if it can
+ * only be the provider for its given part.
* provider for a window.
*/
boolean isWindowContextProvider();

Back to the top