Changeset 5891 in josm for trunk/src/org/openstreetmap/josm/gui/progress/ProgressMonitor.java

Timestamp:

2013-04-20T22:41:13+02:00 (11 years ago)

Author:

stoecker

Message:

fix javadoc

File:

• trunk/src/org/openstreetmap/josm/gui/progress/ProgressMonitor.java (modified) (7 diffs)

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

@@ -36 +36 @@
     }
 
+    /** Ticks count used, when no other value is supplied */
     public final int DEFAULT_TICKS = 10000;
 
@@ -44 +45 @@
     public final int ALL_TICKS = -1;
 
+    /**
+     * Starts this progress monitor. Must be called exactly once
+     * Ticks count is set to default value
+     * @param title title text of the task
+     */
     void beginTask(String title);
 
     /**
      * Starts this progress monitor. Must be called exactly once
-     * @param title
-     * @param ticks
+     * @param title title text of the task
+     * @param ticks number of work units (see {@link #setTicksCount(int ticks)})
      */
     void beginTask(String title, int ticks);
@@ -58 +64 @@
      * then further calls are ignored)
      */
+    void finishTask();
 
-    void finishTask();
     /**
      * Can be used if method receive ProgressMonitor but it's not interested progress monitoring.
@@ -71 +77 @@
 
     /**
-     *
+     * Set the total number of work units
      * @param ticks Number of total work units
      */
     void setTicksCount(int ticks);
+
     /**
-     *
+     * Get the total number of work units
+     * @return Number of total work units
+     */
+    int getTicksCount();
+
+    /**
+     * Set the current number of work units
      * @param ticks Number of work units already done
      */
     void setTicks(int ticks);
 
+    /**
+     * Get the current number of work units
+     * @return Number of work units already done
+     */
     int getTicks();
-    int getTicksCount();
 
     /**
      * Increase number of already done work units by ticks
-     * @param ticks
+     * @param ticks number of ticks to add
      */
     void worked(int ticks);
@@ -92 +108 @@
     /**
      * Subtask that will show progress running back and forth
-     * @param title Can be null, in that case task title is not changed
+     * @param title Can be {@code null}, in that case task title is not changed
      */
     void indeterminateSubTask(String title);
+
     /**
      * Normal subtask
-     * @param title Can be null, in that case task title is not changed
+     * @param title Can be {@code null}, in that case task title is not changed
      */
+
     void subTask(String title);
     /**
      * Shows additional text
      */
+
     void setCustomText(String text);
     /**
@@ -118 +137 @@
     ProgressMonitor createSubTaskMonitor(int ticks, boolean internal);
 
+    /**
+     * Returns the state of user aborts
+     * @return {@code true} if user aborted operation
+     */
     boolean isCanceled();
+
+    /**
+     * Abort current operation, usually called when user somehow requested an abort
+     */
     void cancel();
+
+    /**
+     * Add listener for user abort action
+     * @param listener the listener for cancel operation
+     */
     void addCancelListener(CancelListener listener);
+
+    /**
+     * Remove listener for user abort action
+     * @param listener the listener for cancel operation
+     */
     void removeCancelListener(CancelListener listener);
 
@@ -131 +168 @@
 
     /**
-     * Should be used only by PleaseWaitRunnable. If taskId <> null then "In background" button will be shown
-     * @param taskId
+     * Set the task ID of the progress dialog
+     * Should be used only by PleaseWaitRunnable. If taskId {@code <> null} then "In background" button will be shown
+     * @param taskId the task ID
      */
     void setProgressTaskId(ProgressTaskId taskId);
 
     /**
+     * Returns the task ID of the progress dialog
      * Should be used only by PleaseWaitRunnable
-     * @param taskId
+     * @return the task ID
      */
     ProgressTaskId getProgressTaskId();
 
     /**
-     *
+     * Return the parent windows of progress dialog
      * @return component suitable as parent for dialogs that wants to be shown in front of progress dialog
      */