Changeset 11673 in josm for trunk/src/org

Timestamp:

2017-03-05T00:15:30+01:00 (8 years ago)

Author:

michael2402

Message:

Add more Javadoc for progress monitors.

Location:

trunk/src/org/openstreetmap/josm/gui

Files:

• PleaseWaitDialog.java (modified) (1 diff)
• progress/PleaseWaitProgressMonitor.java (modified) (2 diffs)

trunk/src/org/openstreetmap/josm/gui/PleaseWaitDialog.java

@@ -213 +213 @@
      * Sets the maximum progress value.
      * @param progressBarMax The value that represents the rightmost point of the progress bar (100%).
+     * @since 11672
      */
     public void setMaximumProgress(int progressBarMax) {

trunk/src/org/openstreetmap/josm/gui/progress/PleaseWaitProgressMonitor.java

@@ -26 +26 @@
         void setVisible(boolean visible);
 
+        /**
+         * Updates the progress value to the specified progress.
+         * @param progress The progress as integer. Between 0 and {@link PleaseWaitProgressMonitor#PROGRESS_BAR_MAX}
+         */
         void updateProgress(int progress);
 
@@ -38 +42 @@
     }
 
+    /**
+     * The maximum value the progress bar that displays the current progress should have.
+     */
     public static final int PROGRESS_BAR_MAX = 10_000;
     private final Component dialogParent;