Fix progress tests, update Progress jDoc

[nikiroo-utils.git] / src / be / nikiroo / utils / Progress.java

diff --git a/src/be/nikiroo/utils/Progress.java b/src/be/nikiroo/utils/Progress.java
index a8940fc00816cb8a84a596faef013fcc0b35d2c8..62e46874c3e0918ff49877f74b4d7314bae0be83 100644 (file)
--- a/src/be/nikiroo/utils/Progress.java
+++ b/src/be/nikiroo/utils/Progress.java
@@ -19,7 +19,10 @@ public class Progress {
                 * A progression event.
                 * 
                 * @param progress
-                *            the {@link Progress} object that generated it
+                *            the {@link Progress} object that generated it, not
+                *            necessarily the same as the one where the listener was
+                *            attached (it could be a child {@link Progress} of this
+                *            {@link Progress}).
                 * @param name
                 *            the first non-null name of the {@link Progress} step that
                 *            generated this event
@@ -257,6 +260,10 @@ public class Progress {
 
        /**
         * Add a {@link ProgressListener} that will trigger on progress changes.
+        * <p>
+        * Note: the {@link Progress} that will be reported will be the active
+        * progress, not necessarily the same as the current one (it could be a
+        * child {@link Progress} of this {@link Progress}).
         * 
         * @param l
         *            the listener