Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichael Rennie2009-05-25 09:48:45 -0400
committerMichael Rennie2009-05-25 09:48:45 -0400
commit55a06ad5d9377e274f8815dea97c9d2427e721a7 (patch)
tree8e94003d3fcfd4982022afc6b431931d51c44a75
parent90a3f1a15d6fba7a586f33de42b4c14464ee3bbc (diff)
downloadeclipse.platform.debug-55a06ad5d9377e274f8815dea97c9d2427e721a7.tar.gz
eclipse.platform.debug-55a06ad5d9377e274f8815dea97c9d2427e721a7.tar.xz
eclipse.platform.debug-55a06ad5d9377e274f8815dea97c9d2427e721a7.zip
Bug 76481 [doc] In the doc for org.eclipse.debug.ui.AbstractLaunchConfigurationTab, setDirty is badly described
-rw-r--r--org.eclipse.debug.ui/ui/org/eclipse/debug/ui/AbstractLaunchConfigurationTab.java17
1 files changed, 11 insertions, 6 deletions
diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/ui/AbstractLaunchConfigurationTab.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/ui/AbstractLaunchConfigurationTab.java
index f9b7adef0..bf1522f83 100644
--- a/org.eclipse.debug.ui/ui/org/eclipse/debug/ui/AbstractLaunchConfigurationTab.java
+++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/ui/AbstractLaunchConfigurationTab.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2007 IBM Corporation and others.
+ * Copyright (c) 2000, 2009 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
@@ -306,8 +306,10 @@ public abstract class AbstractLaunchConfigurationTab implements ILaunchConfigura
/**
- * Returns whether this tab is dirty. It is up to clients to set/reset and consult
- * this attribute as required. By default, a tab is initialized to dirty.
+ * Returns if this tab has pending changes that need to be saved.
+ *
+ * It is up to clients to set/reset and consult this attribute as required.
+ * By default, a tab is initialized to dirty for backwards compatibility.
*
* @return whether this tab is dirty
* @since 2.1
@@ -317,10 +319,13 @@ public abstract class AbstractLaunchConfigurationTab implements ILaunchConfigura
}
/**
- * Sets the dirty state of the tab. It is up to clients to set/reset and consult
- * this attribute as required. By default, a tab is initialized to dirty.
+ * Sets the dirty state of the tab. Setting this flag allows clients to
+ * explicitly say whether this tab has pending changes or not.
+ *
+ * It is up to clients to set/reset and consult this attribute as required.
+ * By default, a tab is initialized to dirty for backwards compatibility.
*
- * @param dirty whether this tab is dirty
+ * @param dirty what to set the dirty flag to
* @since 2.1
*/
protected void setDirty(boolean dirty) {

Back to the top