Bug 493029 - SubMonitor's suppressFlags arguments are undocumented
Signed-off-by: Stefan Xenos <sxenos@gmail.com>
diff --git a/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/SubMonitor.java b/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/SubMonitor.java
index 0b513d0..47500fd 100644
--- a/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/SubMonitor.java
+++ b/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/SubMonitor.java
@@ -772,6 +772,10 @@
* </pre></code>
*
* @param totalWork number of ticks to consume from the receiver
+ * @param suppressFlags a bitwise combination of SUPPRESS_* flags. They can be used to suppress
+ * various behaviors on the newly-created monitor. Callers should generally include
+ * the {@link #SUPPRESS_BEGINTASK} flag unless they are invoking a method whose JavaDoc specifically
+ * states that the string argument to {@link #beginTask(String, int)} must be preserved.
* @return new sub progress monitor that may be used in place of a new SubMonitor
*/
public SubMonitor newChild(int totalWork, int suppressFlags) {
@@ -943,7 +947,10 @@
* </pre></code>
*
* @param totalWork number of ticks to consume from the receiver
- * @param suppressFlags TODO
+ * @param suppressFlags a bitwise combination of SUPPRESS_* flags. They can be used to suppress
+ * various behaviors on the newly-created monitor. Callers should generally include
+ * the {@link #SUPPRESS_BEGINTASK} flag unless they are invoking a method whose JavaDoc specifically
+ * states that the string argument to {@link #beginTask(String, int)} must be preserved.
* @return new sub progress monitor that may be used in place of a new SubMonitor
* @throws OperationCanceledException if the monitor has been cancelled
* @since 3.8
