diff options
author | Stefan Xenos | 2016-05-04 18:53:52 +0000 |
---|---|---|
committer | Stefan Xenos | 2016-05-04 18:54:08 +0000 |
commit | 2d7d0263a15413e578fea33448b8093c96089941 (patch) | |
tree | 3b4c3a5ae6d29d292431432936c8f6eb2e6d9f23 | |
parent | eec22e21e94943cfcfd2cac52f3ccf685f5f4711 (diff) | |
download | rt.equinox.bundles-2d7d0263a15413e578fea33448b8093c96089941.tar.gz rt.equinox.bundles-2d7d0263a15413e578fea33448b8093c96089941.tar.xz rt.equinox.bundles-2d7d0263a15413e578fea33448b8093c96089941.zip |
Bug 493029 - SubMonitor's suppressFlags arguments are undocumentedI20160508-2000I20160507-1500I20160506-2000I20160506-1030I20160506-0830I20160505-2000
Signed-off-by: Stefan Xenos <sxenos@gmail.com>
-rw-r--r-- | bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/SubMonitor.java | 9 |
1 files changed, 8 insertions, 1 deletions
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 0b513d024..47500fd60 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 @@ public final class SubMonitor implements IProgressMonitorWithBlocking { * </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 @@ public final class SubMonitor implements IProgressMonitorWithBlocking { * </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 |