Changeset 8926 in josm for trunk/src/org/openstreetmap/josm/tools

Timestamp:

2015-10-22T02:01:00+02:00 (9 years ago)

Author:

Don-vip

Message:

javadoc fixes

Location:

trunk/src/org/openstreetmap/josm/tools

Files:

• Diff.java (modified) (2 diffs)
• Utils.java (modified) (1 diff)
• template_engine/TemplateParser.java (modified) (7 diffs)

trunk/src/org/openstreetmap/josm/tools/Diff.java

@@ -83 +83 @@
     along with this program; if not, write to the Free Software
     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-
  */
-
 public class Diff {
 
@@ -94 +92 @@
       be needed again later to print the results of the comparison as
       an edit script, if desired.
+     * @param a first array
+     * @param b second array
      */
     public Diff(Object[] a, Object[] b) {

trunk/src/org/openstreetmap/josm/tools/Utils.java

@@ -222 +222 @@
 
     /**
-     * return the modulus in the range [0, n)
+     * Return the modulus in the range [0, n)
+     * @param a dividend
+     * @param n divisor
+     * @return modulo (remainder of the Euclidian division of a by n)
      */
     public static int mod(int a, int n) {

trunk/src/org/openstreetmap/josm/tools/template_engine/TemplateParser.java

@@ -1 +1 @@
 // License: GPL. For details, see LICENSE file.
 package org.openstreetmap.josm.tools.template_engine;
-
 
 import static org.openstreetmap.josm.tools.I18n.tr;
@@ -15 +14 @@
 import org.openstreetmap.josm.tools.template_engine.Tokenizer.TokenType;
 
-
+/**
+ * Template parser.
+ */
 public class TemplateParser {
     private final Tokenizer tokenizer;
@@ -22 +23 @@
     private static final Collection<TokenType> CONDITION_WITH_APOSTROPHES_END_TOKENS = Arrays.asList(TokenType.APOSTROPHE);
 
+    /**
+     * Constructs a new {@code TemplateParser}.
+     * @param template template to parse
+     */
     public TemplateParser(String template) {
         this.tokenizer = new Tokenizer(template);
@@ -34 +39 @@
     }
 
+    /**
+     * Parse the template.
+     * @return the resulting template entry
+     * @throws ParseError if the template cannot be parsed
+     */
     public TemplateEntry parse() throws ParseError {
         return parseExpression(EXPRESSION_END_TOKENS);
@@ -91 +101 @@
                     result.getEntries().add(new SearchExpressionCondition(
                             SearchCompiler.compile(searchExpression.getText()), condition));
-                } catch (org.openstreetmap.josm.actions.search.SearchCompiler.ParseError e) {
+                } catch (SearchCompiler.ParseError e) {
                     throw new ParseError(searchExpression.getPosition(), e);
                 }
@@ -121 +131 @@
                 Match match = SearchCompiler.compile(searchExpression.getText());
                 result = new ContextSwitchTemplate(match, template, searchExpression.getPosition());
-            } catch (org.openstreetmap.josm.actions.search.SearchCompiler.ParseError e) {
+            } catch (SearchCompiler.ParseError e) {
                 throw new ParseError(searchExpression.getPosition(), e);
             }
@@ -129 +139 @@
         return result;
     }
-
 }