Changeset 12297 in josm for trunk/src/org/openstreetmap/josm/gui

Timestamp:

2017-06-02T15:31:39+02:00 (7 years ago)

Author:

michael2402

Message:

Javadoc for the changeset dialogs.

Location:

trunk/src/org/openstreetmap/josm/gui/dialogs

Files:

• ChangesetDialog.java (modified) (1 diff)
• changeset/ChangesetCacheManagerModel.java (modified) (4 diffs)

trunk/src/org/openstreetmap/josm/gui/dialogs/ChangesetDialog.java

@@ -559 +559 @@
     }
 
+    /**
+     * Add a separator to the popup menu
+     */
     public void addPopupMenuSeparator() {
         popupMenu.addSeparator();
     }
 
+    /**
+     * Add a menu item to the popup menu
+     * @param a The action to add
+     * @return The menu item that was added.
+     */
     public JMenuItem addPopupMenuAction(Action a) {
         return popupMenu.add(a);

trunk/src/org/openstreetmap/josm/gui/dialogs/changeset/ChangesetCacheManagerModel.java

@@ -22 +22 @@
 /**
  * This is the model for the changeset cache manager dialog.
- *
  */
 public class ChangesetCacheManagerModel extends AbstractTableModel implements ChangesetCacheListener {
@@ -34 +33 @@
     private final PropertyChangeSupport support = new PropertyChangeSupport(this);
 
+    /**
+     * Creates a new ChangesetCacheManagerModel that is based on the selectionModel
+     * @param selectionModel A new selection model that should be used.
+     */
     public ChangesetCacheManagerModel(DefaultListSelectionModel selectionModel) {
         this.selectionModel = selectionModel;
     }
 
+    /**
+     * Adds a property change listener to this model.
+     * @param listener The listener
+     */
     public void addPropertyChangeListener(PropertyChangeListener listener) {
         support.addPropertyChangeListener(listener);
     }
 
+    /**
+     * Removes a property change listener from this model.
+     * @param listener The listener
+     */
     public void removePropertyChangeListener(PropertyChangeListener listener) {
         support.removePropertyChangeListener(listener);
@@ -132 +143 @@
     }
 
+    /**
+     * Initializes the data that is displayed using the changeset cache.
+     */
     public void init() {
         ChangesetCache cc = ChangesetCache.getInstance();
@@ -144 +158 @@
     }
 
+    /**
+     * Destroys and unregisters this model.
+     */
     public void tearDown() {
         ChangesetCache.getInstance().removeChangesetCacheListener(this);
     }
 
+    /**
+     * Gets the selection model this table is based on.
+     * @return The selection model.
+     */
     public DefaultListSelectionModel getSelectionModel() {
         return selectionModel;