Changeset 13158 in josm

Timestamp:

2017-11-25T02:31:32+01:00 (6 years ago)

Author:

Don-vip

Message:

javadoc

Location:

trunk/src/org/openstreetmap/josm

Files:

• actions/SplitWayAction.java (modified) (5 diffs)
• command/Command.java (modified) (1 diff)
• command/conflict/WayNodesConflictResolverCommand.java (modified) (1 diff)
• corrector/ReverseWayTagCorrector.java (modified) (2 diffs)
• corrector/TagCorrector.java (modified) (2 diffs)

trunk/src/org/openstreetmap/josm/actions/SplitWayAction.java

@@ -429 +429 @@
      * @param selection The list of currently selected primitives
      * @return the result from the split operation
-     * @deprecated to be removed end of 2017. Use {@link #splitWay(Way, List, Collection)} instead
+     * @deprecated to be removed end of 2017. Use {@link SplitWayCommand#splitWay} instead
      */
     @Deprecated
@@ -450 +450 @@
      * @return the result from the split operation
      * @since 12718
-     * @deprecated to be removed end of 2017. Use {@link #splitWay(Way, List, Collection)} instead
+     * @deprecated to be removed end of 2017. Use {@link SplitWayCommand#splitWay} instead
      */
     @Deprecated
@@ -475 +475 @@
      * @return the result from the split operation
      * @since 8954
-     * @deprecated to be removed end of 2017. Use {@link #splitWay(Way, List, Collection, Strategy)} instead
+     * @deprecated to be removed end of 2017. Use {@link SplitWayCommand#splitWay} instead
      */
     @Deprecated
@@ -534 +534 @@
      * @param selection The list of currently selected primitives
      * @return the result from the split operation
-     * @deprecated to be removed end of 2017. Use {@link #split(Way, List, Collection)} instead
+     * @deprecated to be removed end of 2017. Use {@link SplitWayCommand#split} instead
      */
     @Deprecated
@@ -556 +556 @@
      * @return the result from the split operation
      * @since 12718
-     * @deprecated to be removed end of 2017. Use {@link #splitWay(Way, List, Collection)} instead
+     * @deprecated to be removed end of 2017. Use {@link SplitWayCommand#split} instead
      */
     @Deprecated

trunk/src/org/openstreetmap/josm/command/Command.java

@@ -45 +45 @@
 
     private static final class CloneVisitor implements OsmPrimitiveVisitor {
-        public final Map<OsmPrimitive, PrimitiveData> orig = new LinkedHashMap<>();
+        final Map<OsmPrimitive, PrimitiveData> orig = new LinkedHashMap<>();
 
         @Override

trunk/src/org/openstreetmap/josm/command/conflict/WayNodesConflictResolverCommand.java

@@ -31 +31 @@
 
     /**
+     * Constructs a new {@code WayNodesConflictResolverCommand}.
      * @param conflict the conflict data set
      * @param mergedNodeList the list of merged nodes

trunk/src/org/openstreetmap/josm/corrector/ReverseWayTagCorrector.java

@@ -190 +190 @@
     }
 
+    /**
+     * Returns the subset of irreversible ways.
+     * @param ways all ways
+     * @return the subset of irreversible ways
+     * @see #isReversible(Way)
+     */
     public static List<Way> irreversibleWays(List<Way> ways) {
         List<Way> newWays = new ArrayList<>(ways);
@@ -200 +206 @@
     }
 
+    /**
+     * Inverts sign of a numeric value.
+     * @param value numeric value
+     * @return opposite numeric value
+     */
     public static String invertNumber(String value) {
         Pattern pattern = Pattern.compile("^([+-]?)(\\d.*)$", Pattern.CASE_INSENSITIVE);

trunk/src/org/openstreetmap/josm/corrector/TagCorrector.java

@@ -43 +43 @@
  *
  * Subclasses call applyCorrections() with maps of the requested
- * corrections and a dialog is pesented to the user to
+ * corrections and a dialog is presented to the user to
  * confirm these changes.
  * @param <P> The type of OSM primitive to correct
@@ -49 +49 @@
 public abstract class TagCorrector<P extends OsmPrimitive> {
 
+    /**
+     * Executes the tag correction.
+     * @param oldprimitive old primitive
+     * @param primitive new primitive
+     * @return A list of commands
+     * @throws UserCancelException If the user canceled
+     * @see #applyCorrections(DataSet, Map, Map, String)
+     */
     public abstract Collection<Command> execute(P oldprimitive, P primitive) throws UserCancelException;