Index: trunk/src/org/openstreetmap/josm/gui/dialogs/LayerListDialog.java =================================================================== --- trunk/src/org/openstreetmap/josm/gui/dialogs/LayerListDialog.java (revision 5890) +++ trunk/src/org/openstreetmap/josm/gui/dialogs/LayerListDialog.java (revision 5891) @@ -345,6 +345,6 @@ * on every {@link ListDataEvent}. * - * @param listener the listener - * @param listSelectionModel the source emitting {@link ListDataEvent}s + * @param listener the listener + * @param listModel the source emitting {@link ListDataEvent}s */ protected void adaptTo(final IEnabledStateUpdating listener, LayerListModel listModel) { @@ -1564,5 +1564,4 @@ * context of this {@link LayerListDialog}. * - * @param layer the layer * @return the action */ @@ -1577,5 +1576,4 @@ * context of this {@link LayerListDialog}. * - * @param layer the layer * @return the action */ Index: trunk/src/org/openstreetmap/josm/gui/dialogs/properties/TagEditHelper.java =================================================================== --- trunk/src/org/openstreetmap/josm/gui/dialogs/properties/TagEditHelper.java (revision 5890) +++ trunk/src/org/openstreetmap/josm/gui/dialogs/properties/TagEditHelper.java (revision 5891) @@ -467,6 +467,4 @@ * Create a focus handling adapter and apply in to the editor component of value * autocompletion box. - * @param keys Box for keys entering and autocompletion - * @param values Box for values entering and autocompletion * @param autocomplete Manager handling the autocompletion * @param comparator Class to decide what values are offered on autocompletion Index: trunk/src/org/openstreetmap/josm/gui/dialogs/relation/MemberTable.java =================================================================== --- trunk/src/org/openstreetmap/josm/gui/dialogs/relation/MemberTable.java (revision 5890) +++ trunk/src/org/openstreetmap/josm/gui/dialogs/relation/MemberTable.java (revision 5891) @@ -39,8 +39,8 @@ /** - * constructor - * - * @param model - * @param columnModel + * constructor for relation member table + * + * @param layer the data layer of the relation + * @param model the table model */ public MemberTable(OsmDataLayer layer, MemberTableModel model) { Index: trunk/src/org/openstreetmap/josm/gui/dialogs/validator/ValidatorTreePanel.java =================================================================== --- trunk/src/org/openstreetmap/josm/gui/dialogs/validator/ValidatorTreePanel.java (revision 5890) +++ trunk/src/org/openstreetmap/josm/gui/dialogs/validator/ValidatorTreePanel.java (revision 5891) @@ -54,4 +54,5 @@ private Set filter = null; + /** a counter to check if tree has been rebuild */ private int updateCount; @@ -288,5 +289,5 @@ /** * Clears the current error list and adds these errors to it - * @param errors The validation errors + * @param newerrors The validation errors */ public void setErrors(List newerrors) { @@ -306,5 +307,5 @@ /** * Returns the errors of the tree - * @return the errors of the tree + * @return the errors of the tree */ public List getErrors() { @@ -312,8 +313,16 @@ } + /** + * Returns the filter list + * @return the list of primitives used for filtering + */ public Set getFilter() { return filter; } + /** + * Set the filter list to a set of primitives + * @param filter the list of primitives used for filtering + */ public void setFilter(Set filter) { if (filter != null && filter.isEmpty()) { @@ -329,5 +338,4 @@ /** * Updates the current errors list - * @param errors The validation errors */ public void resetErrors() { @@ -337,5 +345,5 @@ /** - * Expands all tree + * Expands complete tree */ @SuppressWarnings("unchecked") @@ -359,4 +367,8 @@ } + /** + * Returns a value to check if tree has been rebuild + * @return the current counter + */ public int getUpdateCount() { return updateCount; Index: trunk/src/org/openstreetmap/josm/gui/layer/geoimage/CorrelateGpxWithImages.java =================================================================== --- trunk/src/org/openstreetmap/josm/gui/layer/geoimage/CorrelateGpxWithImages.java (revision 5890) +++ trunk/src/org/openstreetmap/josm/gui/layer/geoimage/CorrelateGpxWithImages.java (revision 5891) @@ -1069,10 +1069,7 @@ * Returns a list of images that fulfill the given criteria. * Default setting is to return untagged images, but may be overwritten. - * @param boolean all -- returns all available images - * @param boolean noexif -- returns untagged images without EXIF-GPS coords - * this parameter is irrelevant if all is true - * @param boolean exif -- also returns images with exif-gps info - * @param boolean tagged -- also returns tagged images - * @return ArrayList matching images + * @param exif also returns images with exif-gps info + * @param tagged also returns tagged images + * @return matching images */ private ArrayList getSortedImgList(boolean exif, boolean tagged) { Index: trunk/src/org/openstreetmap/josm/gui/mappaint/MapPaintStyles.java =================================================================== --- trunk/src/org/openstreetmap/josm/gui/mappaint/MapPaintStyles.java (revision 5890) +++ trunk/src/org/openstreetmap/josm/gui/mappaint/MapPaintStyles.java (revision 5891) @@ -310,5 +310,5 @@ /** * Move position of entries in the current list of StyleSources - * @param sele The indices of styles to be moved. + * @param sel The indices of styles to be moved. * @param delta The number of lines it should move. positive int moves * down and negative moves up. Index: trunk/src/org/openstreetmap/josm/gui/preferences/projection/ProjectionPreference.java =================================================================== --- trunk/src/org/openstreetmap/josm/gui/preferences/projection/ProjectionPreference.java (revision 5890) +++ trunk/src/org/openstreetmap/josm/gui/preferences/projection/ProjectionPreference.java (revision 5891) @@ -47,5 +47,5 @@ * - Search for official references and verify the parameter values. These * documents are often available in the local language only. - * - Use {@link #registerProjectionChoice()}, to make the entry known to JOSM. + * - Use {@link #registerProjectionChoice}, to make the entry known to JOSM. * * In case there is no EPSG code: @@ -405,5 +405,5 @@ * Handles all the work related to update the projection-specific * preferences - * @param proj + * @param pc the choice class representing user selection */ private void selectedProjectionChanged(final ProjectionChoice pc) { @@ -431,4 +431,5 @@ /** * Sets up projection combobox with default values and action listener + * @return the choice class for user selection */ private ProjectionChoice setupProjectionCombo() { Index: trunk/src/org/openstreetmap/josm/gui/progress/ProgressMonitor.java =================================================================== --- trunk/src/org/openstreetmap/josm/gui/progress/ProgressMonitor.java (revision 5890) +++ trunk/src/org/openstreetmap/josm/gui/progress/ProgressMonitor.java (revision 5891) @@ -36,4 +36,5 @@ } + /** Ticks count used, when no other value is supplied */ public final int DEFAULT_TICKS = 10000; @@ -44,10 +45,15 @@ 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,6 +64,6 @@ * then further calls are ignored) */ + void finishTask(); - void finishTask(); /** * Can be used if method receive ProgressMonitor but it's not interested progress monitoring. @@ -71,20 +77,30 @@ /** - * + * 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,15 +108,18 @@ /** * 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,7 +137,25 @@ 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,17 +168,19 @@ /** - * 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 */ Index: trunk/src/org/openstreetmap/josm/gui/tagging/TagEditorModel.java =================================================================== --- trunk/src/org/openstreetmap/josm/gui/tagging/TagEditorModel.java (revision 5890) +++ trunk/src/org/openstreetmap/josm/gui/tagging/TagEditorModel.java (revision 5891) @@ -47,5 +47,5 @@ * for row selection and column selection. * - * To create a {@link JTable} with this model: + * To create a {@link javax.swing.JTable} with this model: * 
      *    TagEditorModel model = new TagEditorModel();
@@ -359,7 +359,7 @@
 
     /**
-     * initializes the model with the tags of an OSM primitive
-     *
-     * @param primitive the OSM primitive
+     * Initializes the model with the tags of an OSM primitive
+     *
+     * @param tags the tags of an OSM primitive
      */
     public void initFromTags(Map tags) {