Index: trunk/src/org/openstreetmap/josm/actions/downloadtasks/DownloadNotesTask.java
===================================================================
--- trunk/src/org/openstreetmap/josm/actions/downloadtasks/DownloadNotesTask.java (revision 12283)
+++ trunk/src/org/openstreetmap/josm/actions/downloadtasks/DownloadNotesTask.java (revision 12284)
@@ -30,5 +30,10 @@
import org.xml.sax.SAXException;
-/** Task for downloading notes */
+/**
+ * General task for downloading OSM notes.
+ *
+ * It handles two URL patterns: API call and dump file export.
+ * @since 7531
+ */
public class DownloadNotesTask extends AbstractDownloadTask {
Index: trunk/src/org/openstreetmap/josm/actions/downloadtasks/DownloadNotesUrlBoundsTask.java
===================================================================
--- trunk/src/org/openstreetmap/josm/actions/downloadtasks/DownloadNotesUrlBoundsTask.java (revision 12283)
+++ trunk/src/org/openstreetmap/josm/actions/downloadtasks/DownloadNotesUrlBoundsTask.java (revision 12284)
@@ -9,4 +9,10 @@
import org.openstreetmap.josm.tools.OsmUrlToBounds;
+/**
+ * Specialized task for downloading OSM notes within bounds.
+ *
+ * It handles one URL pattern: openstreetmap website URL with {@code #map?} argument.
+ * @since 8195
+ */
public class DownloadNotesUrlBoundsTask extends DownloadNotesTask {
Index: trunk/src/org/openstreetmap/josm/actions/downloadtasks/DownloadNotesUrlIdTask.java
===================================================================
--- trunk/src/org/openstreetmap/josm/actions/downloadtasks/DownloadNotesUrlIdTask.java (revision 12283)
+++ trunk/src/org/openstreetmap/josm/actions/downloadtasks/DownloadNotesUrlIdTask.java (revision 12284)
@@ -10,4 +10,10 @@
import org.openstreetmap.josm.gui.progress.ProgressMonitor;
+/**
+ * Specialized task for downloading OSM notes by ID.
+ *
+ * It handles one URL pattern: openstreetmap website URL with {@code /node/} argument.
+ * @since 8195
+ */
public class DownloadNotesUrlIdTask extends DownloadNotesTask {
Index: trunk/src/org/openstreetmap/josm/actions/downloadtasks/DownloadOsmIdTask.java
===================================================================
--- trunk/src/org/openstreetmap/josm/actions/downloadtasks/DownloadOsmIdTask.java (revision 12283)
+++ trunk/src/org/openstreetmap/josm/actions/downloadtasks/DownloadOsmIdTask.java (revision 12284)
@@ -16,4 +16,10 @@
import org.openstreetmap.josm.gui.progress.ProgressMonitor;
+/**
+ * Specialized task for downloading OSM objects by ID.
+ *
+ * It handles one URL pattern: openstreetmap website URL with {@code /(node|way|relation)/} argument.
+ * @since 8240
+ */
public class DownloadOsmIdTask extends DownloadOsmTask {
Index: trunk/src/org/openstreetmap/josm/actions/downloadtasks/PostDownloadHandler.java
===================================================================
--- trunk/src/org/openstreetmap/josm/actions/downloadtasks/PostDownloadHandler.java (revision 12283)
+++ trunk/src/org/openstreetmap/josm/actions/downloadtasks/PostDownloadHandler.java (revision 12284)
@@ -22,4 +22,8 @@
import org.openstreetmap.josm.tools.Utils;
+/**
+ * The powst-download handler notifies user of potential errors that occurred.
+ * @since 2322
+ */
public class PostDownloadHandler implements Runnable {
private final DownloadTask task;
Index: trunk/src/org/openstreetmap/josm/actions/mapmode/DrawAction.java
===================================================================
--- trunk/src/org/openstreetmap/josm/actions/mapmode/DrawAction.java (revision 12283)
+++ trunk/src/org/openstreetmap/josm/actions/mapmode/DrawAction.java (revision 12284)
@@ -1315,4 +1315,7 @@
}
+ /**
+ * Undo the last command. Binded by default to backspace key.
+ */
public class BackSpaceAction extends AbstractAction {
Index: trunk/src/org/openstreetmap/josm/actions/mapmode/MapMode.java
===================================================================
--- trunk/src/org/openstreetmap/josm/actions/mapmode/MapMode.java (revision 12283)
+++ trunk/src/org/openstreetmap/josm/actions/mapmode/MapMode.java (revision 12284)
@@ -117,4 +117,8 @@
}
+ /**
+ * Returns a short translated help message describing how this map mode can be used, to be displayed in status line.
+ * @return a short translated help message describing how this map mode can be used
+ */
public String getModeHelpText() {
return "";
Index: trunk/src/org/openstreetmap/josm/actions/mapmode/ParallelWays.java
===================================================================
--- trunk/src/org/openstreetmap/josm/actions/mapmode/ParallelWays.java (revision 12283)
+++ trunk/src/org/openstreetmap/josm/actions/mapmode/ParallelWays.java (revision 12284)
@@ -22,5 +22,5 @@
/**
- * Helper for ParallelWayAction
+ * Helper for {@link ParallelWayAction}.
*
* @author Ole Jørgen Brønner (olejorgenb)
@@ -35,5 +35,10 @@
private final EastNorth[] normals;
- // Need a reference way to determine the direction of the offset when we manage multiple ways
+ /**
+ * Constructs a new {@code ParallelWays}.
+ * @param sourceWays source ways
+ * @param copyTags whether tags should be copied
+ * @param refWayIndex Need a reference way to determine the direction of the offset when we manage multiple ways
+ */
public ParallelWays(Collection sourceWays, boolean copyTags, int refWayIndex) {
// Possible/sensible to use PrimetiveDeepCopy here?
@@ -118,4 +123,8 @@
}
+ /**
+ * Determines if the nodes graph form a closed path
+ * @return {@code true} if the nodes graph form a closed path
+ */
public boolean isClosedPath() {
return sortedNodes.get(0) == sortedNodes.get(sortedNodes.size() - 1);
@@ -169,7 +178,9 @@
}
+ /**
+ * Performs the action by adding a new sequence command to the undo/redo queue.
+ */
public void commit() {
- SequenceCommand undoCommand = new SequenceCommand("Make parallel way(s)", makeAddWayAndNodesCommandList());
- Main.main.undoRedo.add(undoCommand);
+ Main.main.undoRedo.add(new SequenceCommand("Make parallel way(s)", makeAddWayAndNodesCommandList()));
}
@@ -195,4 +206,8 @@
}
+ /**
+ * Returns the resulting parallel ways.
+ * @return the resulting parallel ways
+ */
public final List getWays() {
return ways;
Index: trunk/src/org/openstreetmap/josm/actions/mapmode/SelectAction.java
===================================================================
--- trunk/src/org/openstreetmap/josm/actions/mapmode/SelectAction.java (revision 12283)
+++ trunk/src/org/openstreetmap/josm/actions/mapmode/SelectAction.java (revision 12284)
@@ -124,5 +124,5 @@
private boolean lassoMode;
- public boolean repeatedKeySwitchLassoOption;
+ private boolean repeatedKeySwitchLassoOption;
// Cache previous mouse event (needed when only the modifier keys are