Changeset 9230 in josm for trunk/src/org/openstreetmap/josm/actions

Timestamp:

2015-12-31T16:37:24+01:00 (8 years ago)

Author:

Don-vip

Message:

fix javadoc errors/warnings

Location:

trunk/src/org/openstreetmap/josm/actions

Files:

• OpenFileAction.java (modified) (8 diffs)
• OrthogonalizeAction.java (modified) (7 diffs)
• PasteTagsAction.java (modified) (6 diffs)
• RenameLayerAction.java (modified) (1 diff)
• SimplifyWayAction.java (modified) (4 diffs)
• SplitWayAction.java (modified) (4 diffs)
• UnGlueAction.java (modified) (7 diffs)
• downloadtasks/DownloadTask.java (modified) (1 diff)
• downloadtasks/DownloadTaskList.java (modified) (2 diffs)
• mapmode/DeleteAction.java (modified) (2 diffs)
• mapmode/DrawAction.java (modified) (2 diffs)

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

@@ -82 +82 @@
     /**
      * Open a list of files. The complete list will be passed to batch importers.
+     * Filenames will not be saved in history.
      * @param fileList A list of files
      */
@@ -88 +89 @@
     }
 
+    /**
+     * Open a list of files. The complete list will be passed to batch importers.
+     * @param fileList A list of files
+     * @param recordHistory {@code true} to save filename in history (default: false)
+     */
     public static void openFiles(List<File> fileList, boolean recordHistory) {
         OpenFileTask task = new OpenFileTask(fileList, null);
@@ -94 +100 @@
     }
 
+    /**
+     * Task to open files.
+     */
     public static class OpenFileTask extends PleaseWaitRunnable {
         private final List<File> files;
@@ -103 +112 @@
         private boolean recordHistory;
 
+        /**
+         * Constructs a new {@code OpenFileTask}.
+         * @param files files to open
+         * @param fileFilter file filter
+         * @param title message for the user
+         */
         public OpenFileTask(final List<File> files, final FileFilter fileFilter, final String title) {
             super(title, false /* don't ignore exception */);
@@ -130 +145 @@
         }
 
+        /**
+         * Constructs a new {@code OpenFileTask}.
+         * @param files files to open
+         * @param fileFilter file filter
+         */
         public OpenFileTask(List<File> files, FileFilter fileFilter) {
             this(files, fileFilter, tr("Opening files"));
@@ -135 +155 @@
 
         /**
-         * save filename in history (for list of recently opened files)
-         * default: false
+         * Sets whether to save filename in history (for list of recently opened files).
+         * @param recordHistory {@code true} to save filename in history (default: false)
          */
         public void setRecordHistory(boolean recordHistory) {
@@ -142 +162 @@
         }
 
+        /**
+         * Determines if filename must be saved in history (for list of recently opened files).
+         * @return {@code true} if filename must be saved in history
+         */
         public boolean isRecordHistory() {
             return recordHistory;
@@ -319 +343 @@
         }
 
+        /**
+         * Import data files with the given importer.
+         * @param importer file importer
+         * @param files data files to import
+         */
         public void importData(FileImporter importer, List<File> files) {
             if (importer.isBatchImporter()) {

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

@@ -199 +199 @@
     /**
      * Collect groups of ways with common nodes in order to orthogonalize each group separately.
+     * @param wayDataList list of ways
      * @return groups of ways with common nodes
      */
@@ -246 +247 @@
      *      - The same for vertical segments.
      *  5. Rotate back.
+     * @param wayDataList list of ways
+     * @param headingNodes list of heading nodes
      * @return list of commands to perform
      * @throws InvalidUserInputException if selected ways have an angle different from 90 or 180 degrees
@@ -398 +401 @@
 
     /**
-     * Class contains everything we need to know about a singe way.
+     * Class contains everything we need to know about a single way.
      */
     private static class WayData {
@@ -477 +480 @@
     /**
      * Make sure angle (up to 2*Pi) is in interval [ 0, 2*Pi ).
+     * @param a angle
      * @return correct angle
      */
@@ -491 +495 @@
     /**
      * Make sure angle (up to 2*Pi) is in interval ( -Pi, Pi ].
+     * @param a angle
      * @return correct angle
      */
@@ -513 +518 @@
         /**
          * Rotate counter-clock-wise.
+         * @param pivot pivot
+         * @param en original east/north
+         * @param angle angle, in radians
          * @return new east/north
          */
@@ -541 +549 @@
      * Recognize angle to be approximately 0, 90, 180 or 270 degrees.
      * returns an integral value, corresponding to a counter clockwise turn.
+     * @param a angle, in radians
+     * @param deltaMax maximum tolerance, in radians
      * @return an integral value, corresponding to a counter clockwise turn
      * @throws RejectedAngleException in case of invalid angle

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

@@ -59 +59 @@
         private final List<Tag> tags = new ArrayList<>();
 
+        /**
+         * Constructs a new {@code TagPaster}.
+         * @param source source primitives
+         * @param target target primitives
+         */
         public TagPaster(Collection<PrimitiveData> source, Collection<OsmPrimitive> target) {
             this.source = source;
@@ -69 +74 @@
          * @return true if the source for tag pasting is heterogeneous
          */
-        protected boolean isHeteogeneousSource() {
+        protected boolean isHeterogeneousSource() {
             int count = 0;
             count = !getSourcePrimitivesByType(OsmPrimitiveType.NODE).isEmpty() ? count + 1 : count;
@@ -230 +235 @@
         }
 
+        /**
+         * Performs the paste operation.
+         * @return list of tags
+         */
         public List<Tag> execute() {
             tags.clear();
-            if (isHeteogeneousSource()) {
+            if (isHeterogeneousSource()) {
                 pasteFromHeterogeneousSource();
             } else {
@@ -258 +267 @@
     }
 
-    /** Paste tags from arbitrary text, not using JOSM buffer
+    /**
+     * Paste tags from arbitrary text, not using JOSM buffer
+     * @param selection selected primitives
+     * @param text text containing tags
      * @return true if action was successful
+     * @see TextTagParser#readTagsFromText
      */
     public static boolean pasteTagsFromText(Collection<OsmPrimitive> selection, String text) {
@@ -278 +291 @@
     }
 
-    /** Paste tags from JOSM buffer
+    /**
+     * Paste tags from JOSM buffer
      * @param selection objects that will have the tags
      * @return false if JOSM buffer was empty
@@ -297 +311 @@
     /**
      * Create and execute SequenceCommand with descriptive title
+     * @param selection selected primitives
      * @param commands the commands to perform in a sequential command
      */

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

@@ -32 +32 @@
 
     /**
+     * Constructs a new {@code RenameLayerAction}.
      * @param file The file of the original location of this layer.
      *      If null, no possibility to "rename the file as well" is provided.
+     * @param layer layer to rename
      */
     public RenameLayerAction(File file, Layer layer) {

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

@@ -27 +27 @@
 import org.openstreetmap.josm.data.osm.OsmPrimitive;
 import org.openstreetmap.josm.data.osm.Way;
+import org.openstreetmap.josm.data.projection.Ellipsoid;
 import org.openstreetmap.josm.gui.HelpAwareOptionPane;
 import org.openstreetmap.josm.gui.HelpAwareOptionPane.ButtonSpec;
@@ -217 +218 @@
      * @param to the upper index
      * @param threshold the max error threshold
+     * @param simplifiedNodes list that will contain resulting nodes
      */
     protected void buildSimplifiedNodeList(List<Node> wnew, int from, int to, double threshold, List<Node> simplifiedNodes) {
@@ -228 +230 @@
         for (int i = from + 1; i < to; i++) {
             Node n = wnew.get(i);
-            double xte = Math.abs(EARTH_RAD
+            double xte = Math.abs(Ellipsoid.WGS84.a
                     * xtd(fromN.getCoor().lat() * Math.PI / 180, fromN.getCoor().lon() * Math.PI / 180, toN.getCoor().lat() * Math.PI
                             / 180, toN.getCoor().lon() * Math.PI / 180, n.getCoor().lat() * Math.PI / 180, n.getCoor().lon() * Math.PI
@@ -253 +255 @@
     }
 
-    public static final double EARTH_RAD = 6378137.0;
-
     /* From Aviaton Formulary v1.3
      * http://williams.best.vwh.net/avform.htm

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

@@ -55 +55 @@
  * original order.  Selected nodes at the end of a way are ignored.
  */
-
 public class SplitWayAction extends JosmAction {
 
@@ -320 +319 @@
         /**
          * Returns a strategy which selects the way chunk with the highest node count to keep.
+         * @return strategy which selects the way chunk with the highest node count to keep
          */
         public static Strategy keepLongestChunk() {
@@ -338 +338 @@
         /**
          * Returns a strategy which selects the first way chunk.
+         * @return strategy which selects the first way chunk
          */
         public static Strategy keepFirstChunk() {
@@ -348 +349 @@
         }
     }
-
 
     /**

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

@@ -165 +165 @@
      * Assumes there is one tagged Node stored in selectedNode that it will try to unglue.
      * (i.e. copy node and remove all tags from the old one. Relations will not be removed)
+     * @param e event that trigerred the action
      */
     private void unglueNode(ActionEvent e) {
@@ -217 +218 @@
      * Checks only if the number and type of items selected looks good.
      *
-     * If this method returns "true", selectedNode and selectedWay will
-     * be set.
+     * If this method returns "true", selectedNode and selectedWay will be set.
      *
      * Returns true if either one node is selected or one node and one
      * way are selected and the node is part of the way.
      *
-     * The way will be put into the object variable "selectedWay", the
-     * node into "selectedNode".
+     * The way will be put into the object variable "selectedWay", the node into "selectedNode".
+     * @param selection selected primitives
      * @return true if either one node is selected or one node and one way are selected and the node is part of the way
      */
@@ -255 +255 @@
      * Checks only if the number and type of items selected looks good.
      *
-     * Returns true if one way and any number of nodes that are part of
-     * that way are selected. Note: "any" can be none, then all nodes of
-     * the way are used.
-     *
-     * The way will be put into the object variable "selectedWay", the
-     * nodes into "selectedNodes".
+     * Returns true if one way and any number of nodes that are part of that way are selected.
+     * Note: "any" can be none, then all nodes of the way are used.
+     *
+     * The way will be put into the object variable "selectedWay", the nodes into "selectedNodes".
+     * @param selection selected primitives
      * @return true if one way and any number of nodes that are part of that way are selected
      */
@@ -298 +297 @@
      * dupe the given node of the given way
      *
-     * assume that OrginalNode is in the way
+     * assume that originalNode is in the way
      * <ul>
      * <li>the new node will be put into the parameter newNodes.</li>
@@ -304 +303 @@
      * <li>the changed way will be returned and must be put into cmds by the caller!</li>
      * </ul>
-     * @return new way
+     * @param originalNode original node to duplicate
+     * @param w parent way
+     * @param cmds List of commands that will contain the new "add node" command
+     * @param newNodes List of nodes that will contain the new node
+     * @return new way The modified way. Change command mus be handled by the caller
      */
     private static Way modifyWay(Node originalNode, Way w, List<Command> cmds, List<Node> newNodes) {
@@ -327 +330 @@
     /**
      * put all newNodes into the same relation(s) that originalNode is in
+     * @param originalNode original node to duplicate
+     * @param cmds List of commands that will contain the new "change relation" commands
+     * @param newNodes List of nodes that contain the new node
      */
     private void fixRelations(Node originalNode, List<Command> cmds, List<Node> newNodes) {
@@ -343 +349 @@
                         rolesToReAdd = new HashMap<>();
                     }
-                    rolesToReAdd.put(rm.getRole(), i);
+                    if (rolesToReAdd != null) {
+                        rolesToReAdd.put(rm.getRole(), i);
+                    }
                 }
                 i++;
             }
             if (newRel != null) {
-                for (Node n : newNodes) {
-                    for (Map.Entry<String, Integer> role : rolesToReAdd.entrySet()) {
-                        newRel.addMember(role.getValue() + 1, new RelationMember(role.getKey(), n));
+                if (rolesToReAdd != null) {
+                    for (Node n : newNodes) {
+                        for (Map.Entry<String, Integer> role : rolesToReAdd.entrySet()) {
+                            newRel.addMember(role.getValue() + 1, new RelationMember(role.getKey(), n));
+                        }
                     }
                 }

trunk/src/org/openstreetmap/josm/actions/downloadtasks/DownloadTask.java

@@ -125 +125 @@
      * @param url The URL to be confirmed
      * @return The HTML-formatted confirmation message to be shown to user
-     * @since
+     * @since 5691
      */
     String getConfirmationMessage(URL url);

trunk/src/org/openstreetmap/josm/actions/downloadtasks/DownloadTaskList.java

@@ -120 +120 @@
 
     /**
-     * Replies the set of ids of all complete, non-new primitives (i.e. those with !
-     * primitive.incomplete)
+     * Replies the set of ids of all complete, non-new primitives (i.e. those with !primitive.incomplete)
+     * @param ds data set
      *
      * @return the set of ids of all complete, non-new primitives
@@ -285 +285 @@
             for (DownloadTask task : tasks) {
                 if (task instanceof AbstractDownloadTask) {
-                    AbstractDownloadTask absTask = (AbstractDownloadTask) task;
+                    AbstractDownloadTask<?> absTask = (AbstractDownloadTask<?>) task;
                     if (absTask.isCanceled() || absTask.isFailed())
                         return;

trunk/src/org/openstreetmap/josm/actions/mapmode/DeleteAction.java

@@ -256 +256 @@
      * occurs. We can use AWTEvent to catch those but still lack a proper
      * mouseevent. Instead we copy the previous event and only update the modifiers.
+     * @param e mouse event
+     * @param modifiers mouse modifiers
      */
     private void giveUserFeedback(MouseEvent e, int modifiers) {
@@ -266 +268 @@
      * calls the cursor and target highlighting routines. Extracts modifiers
      * from mouse event.
+     * @param e mouse event
      */
     private void giveUserFeedback(MouseEvent e) {

trunk/src/org/openstreetmap/josm/actions/mapmode/DrawAction.java

@@ -894 +894 @@
 
     /**
-     * if one of the ends of @param way is given @param node ,
+     * if one of the ends of {@code way} is given {@code  node},
      * then set  currentBaseNode = node and previousNode = adjacent node of way
+     * @param way way to continue
+     * @param node starting node
      */
     private void continueWayFromNode(Way way, Node node) {
@@ -926 +928 @@
 
     /**
+     * @param n node
      * @return If the node is the end of exactly one way, return this.
      *  <code>null</code> otherwise.