Changeset 35681 in osm for applications/editors/josm/plugins/utilsplugin2

Timestamp:

2021-01-11T09:57:43+01:00 (4 years ago)

Author:

GerdP

Message:

improve javadoc

File:

• applications/editors/josm/plugins/utilsplugin2/src/org/openstreetmap/josm/plugins/utilsplugin2/replacegeometry/ReplaceGeometryUtils.java (modified) (6 diffs)

applications/editors/josm/plugins/utilsplugin2/src/org/openstreetmap/josm/plugins/utilsplugin2/replacegeometry/ReplaceGeometryUtils.java

@@ -55 +55 @@
     /**
      * Replace new or uploaded object with new object
+     * @param firstObject an object
+     * @param secondObject another object
      * @return (in case of success) a command to update the geometry of one primitive and remove the other
      */
@@ -97 +99 @@
     /**
      * Replace a new or uploaded node with a new node
+     * @param firstNode a node
+     * @param secondNode another node
      * @return (in case of success) a command to update the geometry of one primitive and remove the other
      */
@@ -112 +116 @@
     /**
      * Replace a node with another node (similar to MergeNodesAction)
+     * @param subjectNode node to be replaced
+     * @param referenceNode node with greater spatial quality
+     * @return command to replace node or null if user cancelled
      */
     public static ReplaceGeometryCommand buildReplaceNodeCommand(Node subjectNode, Node referenceNode) {
@@ -137 +144 @@
      * @param subjectNode node to be replaced
      * @param referenceObject object with greater spatial quality
+     * @return command to replace
      */
     public static ReplaceGeometryCommand buildUpgradeNodeCommand(Node subjectNode, OsmPrimitive referenceObject) {
@@ -414 +422 @@
      * Checks if a way has at least one important node (e.g. interesting tag,
      * role membership), and thus cannot be safely modified.
+     * @param geometry the new geometry for the replaced way
+     * @param way the way that should be replaced
+     * @return true if at least one node is not in {@code geometry} but is important
      */
     static boolean hasImportantNode(Way geometry, Way way) {
@@ -475 +486 @@
     /**
      * Find node from the collection which is nearest to <tt>node</tt>. Max distance is taken in consideration.
+     * @param node the node
+     * @param nodes the collection
      * @return null if there is no such node.
      */