diff options
author | Stefan Xenos | 2016-08-10 18:27:18 +0000 |
---|---|---|
committer | Thomas Watson | 2016-08-11 18:40:10 +0000 |
commit | 9bdd086c2e4c377251095f565625f2b04b3673f6 (patch) | |
tree | 95848970a4b3554d43102be4ea0203c80f147c86 | |
parent | 4d483b30c4fd75279878065b2bf72d0b1256a2b1 (diff) | |
download | rt.equinox.bundles-9bdd086c2e4c377251095f565625f2b04b3673f6.tar.gz rt.equinox.bundles-9bdd086c2e4c377251095f565625f2b04b3673f6.tar.xz rt.equinox.bundles-9bdd086c2e4c377251095f565625f2b04b3673f6.zip |
Bug 495737 - Update JavaDoc on IProgressMonitor to reflect the 4.7
conventions
Change-Id: I65b70e3b565d20483bdb59d46bd11bfdd5e489a0
Signed-off-by: Stefan Xenos <sxenos@gmail.com>
-rw-r--r-- | bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/IProgressMonitor.java | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/IProgressMonitor.java b/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/IProgressMonitor.java index bc601b23d..1698ec861 100644 --- a/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/IProgressMonitor.java +++ b/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/IProgressMonitor.java @@ -68,6 +68,20 @@ package org.eclipse.core.runtime; * unless the JavaDoc for the callee states otherwise. * </ul> * + * <p> + * The responsibilities described above were introduced in Eclipse 4.7. Prior to + * Eclipse 4.7 it was common practice for the callee to invoke {@link #done()} on + * its monitor and for the caller to rely upon this fact. As of Eclipse 4.6, all + * the important top-level entry points have been updated to call {@link #done()}, + * meaning they work with both methods that invoke {@link #done()} and methods + * that don't. + * </p> + * <p> + * Since this convention was introduced in Eclipse 4.7, some plugin code may need to + * change. In particular, callers are no longer allowed to rely upon the callee + * invoking {@link #done()} on a monitor and must do so themselves if necessary. + * </p> + * <p> * This interface can be used without OSGi running. * </p><p> * Clients may implement this interface. |