Changeset 12115 in josm for trunk/src/org/openstreetmap

Timestamp:

2017-05-11T01:48:13+02:00 (8 years ago)

Author:

michael2402

Message:

Document OsmDataLayer

File:

• trunk/src/org/openstreetmap/josm/gui/layer/OsmDataLayer.java (modified) (4 diffs)

trunk/src/org/openstreetmap/josm/gui/layer/OsmDataLayer.java

@@ -134 +134 @@
     public final List<TestError> validationErrors = new ArrayList<>();
 
+    /**
+     * The default number of relations in the recent relations cache.
+     * @see #getRecentRelations()
+     */
     public static final int DEFAULT_RECENT_RELATIONS_NUMBER = 20;
+    /**
+     * The number of relations to use in the recent relations cache.
+     * @see #getRecentRelations()
+     */
     public static final IntegerProperty PROPERTY_RECENT_RELATIONS_NUMBER = new IntegerProperty("properties.last-closed-relations-size",
             DEFAULT_RECENT_RELATIONS_NUMBER);
+    /**
+     * The extension that should be used when saving the OSM file.
+     */
     public static final StringProperty PROPERTY_SAVE_EXTENSION = new StringProperty("save.extension.osm", "osm");
 
@@ -160 +171 @@
      * @param relation new entry for the list of recently closed relations
      * @since 9668
+     * @see #PROPERTY_RECENT_RELATIONS_NUMBER
      */
     public void setRecentRelation(Relation relation) {
@@ -223 +235 @@
     }
 
+    /**
+     * A listener that counts the number of primitives it encounters
+     */
     public static final class DataCountVisitor extends AbstractVisitor {
+        /**
+         * Nodes that have been visited
+         */
         public int nodes;
+        /**
+         * Ways that have been visited
+         */
         public int ways;
+        /**
+         * Relations that have been visited
+         */
         public int relations;
+        /**
+         * Deleted nodes that have been visited
+         */
         public int deletedNodes;
+        /**
+         * Deleted ways that have been visited
+         */
         public int deletedWays;
+        /**
+         * Deleted relations that have been visited
+         */
         public int deletedRelations;
 
@@ -256 +289 @@
     }
 
+    /**
+     * A listener that gets notified of command queue (undo/redo) size changes.
+     */
     @FunctionalInterface
     public interface CommandQueueListener {
+        /**
+         * Notifies the listener about the new queue size
+         * @param queueSize Undo stack size
+         * @param redoSize Redo stack size
+         */
         void commandChanged(int queueSize, int redoSize);
     }