Changeset 11615 in josm for trunk/src/org

Timestamp:

2017-02-25T14:46:22+01:00 (8 years ago)

Author:

Don-vip

Message:

add javadoc

Location:

trunk/src/org/openstreetmap/josm

Files:

• data/validation/tests/MapCSSTagChecker.java (modified) (2 diffs)
• gui/mappaint/styleelement/LabelCompositionStrategy.java (modified) (4 diffs)
• gui/widgets/ButtonColumn.java (modified) (4 diffs)

trunk/src/org/openstreetmap/josm/data/validation/tests/MapCSSTagChecker.java

@@ -140 +140 @@
         Command createCommand(OsmPrimitive p, Selector matchingSelector);
 
+        /**
+         * Checks that object is either an {@link Expression} or a {@link String}.
+         * @param obj object to check
+         * @throws IllegalArgumentException if object is not an {@code Expression} or a {@code String}
+         */
         static void checkObject(final Object obj) {
             CheckParameterUtil.ensureThat(obj instanceof Expression || obj instanceof String,
@@ -252 +257 @@
     }
 
+    /**
+     * Tag check.
+     */
     public static class TagCheck implements Predicate<OsmPrimitive> {
         /** The selector of this {@code TagCheck} */

trunk/src/org/openstreetmap/josm/gui/mappaint/styleelement/LabelCompositionStrategy.java

@@ -28 +28 @@
  *
  *   <li>{@link DeriveLabelFromNameTagsCompositionStrategy} - the label is given by the value
- *   of one
- *   of the configured "name tags". The list of relevant name tags can be configured
+ *   of one of the configured "name tags". The list of relevant name tags can be configured
  *   in the JOSM preferences
- *   content of a tag whose name specified in the MapCSS style file, see the preference
- *   options <tt>mappaint.nameOrder</tt> and <tt>mappaint.nameComplementOrder</tt>.</li>
+ *   see the preference options <tt>mappaint.nameOrder</tt> and <tt>mappaint.nameComplementOrder</tt>.</li>
  * </ul>
  * @since  3987 (creation)
@@ -50 +48 @@
     String compose(OsmPrimitive primitive);
 
+    /**
+     * Strategy where the label is given by a static text specified in the MapCSS style file.
+     */
     class StaticLabelCompositionStrategy implements LabelCompositionStrategy {
         private final String defaultLabel;
@@ -85 +86 @@
     }
 
+    /**
+     * Strategy where the label is given by the content of a tag whose name specified in the MapCSS style file.
+     */
     class TagLookupCompositionStrategy implements LabelCompositionStrategy {
 
@@ -129 +133 @@
     }
 
+    /**
+     * Strategy where the label is given by the value of one of the configured "name tags".
+     * The list of relevant name tags can be configured in the JOSM preferences
+     * see the preference options <tt>mappaint.nameOrder</tt> and <tt>mappaint.nameComplementOrder</tt>
+     */
     class DeriveLabelFromNameTagsCompositionStrategy implements LabelCompositionStrategy, PreferenceChangedListener {
 

trunk/src/org/openstreetmap/josm/gui/widgets/ButtonColumn.java

@@ -1 +1 @@
 // License: GPL. For details, see LICENSE file.
-
 package org.openstreetmap.josm.gui.widgets;
 
@@ -19 +18 @@
 
 /**
- *
  * Class based on:  http://www.camick.com/java/source/ButtonColumn.java
  * https://tips4java.wordpress.com/2009/07/12/table-button-column/
- *
+ * @since 10536
  */
 public class ButtonColumn extends AbstractCellEditor implements TableCellRenderer, TableCellEditor, ActionListener {
@@ -38 +36 @@
     }
 
+    /**
+     * Constructs a new {@code ButtonColumn}.
+     * @param action action
+     * @param buttonName button name
+     */
     public ButtonColumn(Action action, String buttonName) {
         this(action);
         this.buttonName = buttonName;
     }
-
 
     /**
@@ -116 +118 @@
         return renderButton;
     }
-
 }