Changeset 10137 in josm for trunk/src/org/openstreetmap/josm/data

Timestamp:

2016-04-10T23:53:54+02:00 (8 years ago)

Author:

Don-vip

Message:

sonar, javadoc

Location:

trunk/src/org/openstreetmap/josm/data/validation/util

Files:

• Entities.java (modified) (4 diffs)
• MultipleNameVisitor.java (modified) (1 diff)
• NameVisitor.java (modified) (4 diffs)

trunk/src/org/openstreetmap/josm/data/validation/util/Entities.java

@@ -30 +30 @@
  * @see <a href="http://www.w3.org/TR/html401/charset.html#h-5.3">HTML 4.01 Character References</a>
  * @see <a href="http://www.w3.org/TR/html401/charset.html#code-position">HTML 4.01 Code positions</a>
+ * @since 3669
  */
 public final class Entities {
@@ -340 +341 @@
     }
 
+    /**
+     * Returns unescaped entity representation.
+     * @param str entity
+     * @return unescaped entity representation
+     */
     public static String unescape(String str) {
         int firstAmp = str.indexOf('&');
@@ -357 +363 @@
                 int amphersandIdx = str.indexOf('&', i + 1);
                 if (amphersandIdx != -1 && amphersandIdx < semiColonIdx) {
-                    // Then the text looks like &...&...;
+                    // Then the text looks like "&...&...;"
                     res.append(c);
                     continue;
@@ -365 +371 @@
                 int entityContentLen = entityContent.length();
                 if (entityContentLen > 0) {
-                    if (entityContent.charAt(0) == '#') { // escaped value content is an integer (decimal or
-                        // hexidecimal)
+                    if (entityContent.charAt(0) == '#') { // escaped value content is an integer (decimal or hexidecimal)
                         if (entityContentLen > 1) {
                             char isHexChar = entityContent.charAt(1);

trunk/src/org/openstreetmap/josm/data/validation/util/MultipleNameVisitor.java

@@ -19 +19 @@
 public class MultipleNameVisitor extends NameVisitor {
 
+    /**
+     * Maximum displayed length, in characters.
+     */
     public static final int MULTIPLE_NAME_MAX_LENGTH = 80;
 

trunk/src/org/openstreetmap/josm/data/validation/util/NameVisitor.java

@@ -19 +19 @@
  * @author imi
  */
-//TODO This class used to be in JOSM but it was removed. MultipleNameVisitor depends on it so I copied it here,
-// but MultipleNameVisitor should be refactored instead of using this class
 public class NameVisitor extends AbstractVisitor {
 
@@ -27 +25 @@
      */
     public String className;
+
+    /**
+     * The plural name of the item class
+     */
     public String classNamePlural;
+
     /**
      * The name of this item.
      */
     public String name = "";
+
     /**
      * The icon of this item.
@@ -38 +42 @@
 
     /**
-     * If the node has a name-key or id-key, this is displayed. If not, (lat,lon)
-     * is displayed.
+     * If the node has a name-key or id-key, this is displayed. If not, (lat,lon) is displayed.
      */
     @Override
@@ -69 +72 @@
     }
 
+    /**
+     * Returns an horizontal {@code JLabel} with icon and name.
+     * @return horizontal {@code JLabel} with icon and name
+     */
     public JLabel toLabel() {
         return new JLabel(name, icon, JLabel.HORIZONTAL);