Changeset 12284 in josm for trunk/src/org


Ignore:
Timestamp:
2017-05-31T15:50:05+02:00 (7 years ago)
Author:
Don-vip
Message:

see #14794 - javadoc

Location:
trunk/src/org/openstreetmap/josm/actions
Files:
9 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/org/openstreetmap/josm/actions/downloadtasks/DownloadNotesTask.java

    r11784 r12284  
    3030import org.xml.sax.SAXException;
    3131
    32 /** Task for downloading notes */
     32/**
     33 * General task for downloading OSM notes.
     34 * <p>
     35 * It handles two URL patterns: API call and dump file export.
     36 * @since 7531
     37 */
    3338public class DownloadNotesTask extends AbstractDownloadTask<NoteData> {
    3439

  • trunk/src/org/openstreetmap/josm/actions/downloadtasks/DownloadNotesUrlBoundsTask.java

    r8624 r12284  
    99import org.openstreetmap.josm.tools.OsmUrlToBounds;
    1010
     11/**
     12 * Specialized task for downloading OSM notes within bounds.
     13 * <p>
     14 * It handles one URL pattern: openstreetmap website URL with {@code #map?} argument.
     15 * @since 8195
     16 */
    1117public class DownloadNotesUrlBoundsTask extends DownloadNotesTask {
    1218

  • trunk/src/org/openstreetmap/josm/actions/downloadtasks/DownloadNotesUrlIdTask.java

    r8855 r12284  
    1010import org.openstreetmap.josm.gui.progress.ProgressMonitor;
    1111
     12/**
     13 * Specialized task for downloading OSM notes by ID.
     14 * <p>
     15 * It handles one URL pattern: openstreetmap website URL with {@code /node/<id>} argument.
     16 * @since 8195
     17 */
    1218public class DownloadNotesUrlIdTask extends DownloadNotesTask {
    1319

  • trunk/src/org/openstreetmap/josm/actions/downloadtasks/DownloadOsmIdTask.java

    r8624 r12284  
    1616import org.openstreetmap.josm.gui.progress.ProgressMonitor;
    1717
     18/**
     19 * Specialized task for downloading OSM objects by ID.
     20 * <p>
     21 * It handles one URL pattern: openstreetmap website URL with {@code /(node|way|relation)/<id>} argument.
     22 * @since 8240
     23 */
    1824public class DownloadOsmIdTask extends DownloadOsmTask {
    1925

  • trunk/src/org/openstreetmap/josm/actions/downloadtasks/PostDownloadHandler.java

    r10601 r12284  
    2222import org.openstreetmap.josm.tools.Utils;
    2323
     24/**
     25 * The powst-download handler notifies user of potential errors that occurred.
     26 * @since 2322
     27 */
    2428public class PostDownloadHandler implements Runnable {
    2529    private final DownloadTask task;

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

    r12182 r12284  
    13151315    }
    13161316
     1317    /**
     1318     * Undo the last command. Binded by default to backspace key.
     1319     */
    13171320    public class BackSpaceAction extends AbstractAction {
    13181321

  • trunk/src/org/openstreetmap/josm/actions/mapmode/MapMode.java

    r11993 r12284  
    117117    }
    118118
     119    /**
     120     * Returns a short translated help message describing how this map mode can be used, to be displayed in status line.
     121     * @return a short translated help message describing how this map mode can be used
     122     */
    119123    public String getModeHelpText() {
    120124        return "";

  • trunk/src/org/openstreetmap/josm/actions/mapmode/ParallelWays.java

    r11385 r12284  
    2222
    2323/**
    24  * Helper for ParallelWayAction
     24 * Helper for {@link ParallelWayAction}.
    2525 *
    2626 * @author Ole Jørgen Brønner (olejorgenb)
    … …  
    3535    private final EastNorth[] normals;
    3636
    37     // Need a reference way to determine the direction of the offset when we manage multiple ways
     37    /**
     38     * Constructs a new {@code ParallelWays}.
     39     * @param sourceWays source ways
     40     * @param copyTags whether tags should be copied
     41     * @param refWayIndex Need a reference way to determine the direction of the offset when we manage multiple ways
     42     */
    3843    public ParallelWays(Collection<Way> sourceWays, boolean copyTags, int refWayIndex) {
    3944        // Possible/sensible to use PrimetiveDeepCopy here?
    … …  
    118123    }
    119124
     125    /**
     126     * Determines if the nodes graph form a closed path
     127     * @return {@code true} if the nodes graph form a closed path
     128     */
    120129    public boolean isClosedPath() {
    121130        return sortedNodes.get(0) == sortedNodes.get(sortedNodes.size() - 1);
    … …  
    169178    }
    170179
     180    /**
     181     * Performs the action by adding a new sequence command to the undo/redo queue.
     182     */
    171183    public void commit() {
    172         SequenceCommand undoCommand = new SequenceCommand("Make parallel way(s)", makeAddWayAndNodesCommandList());
    173         Main.main.undoRedo.add(undoCommand);
     184        Main.main.undoRedo.add(new SequenceCommand("Make parallel way(s)", makeAddWayAndNodesCommandList()));
    174185    }
    175186
    … …  
    195206    }
    196207
     208    /**
     209     * Returns the resulting parallel ways.
     210     * @return the resulting parallel ways
     211     */
    197212    public final List<Way> getWays() {
    198213        return ways;

  • trunk/src/org/openstreetmap/josm/actions/mapmode/SelectAction.java

    r12279 r12284  
    124124
    125125    private boolean lassoMode;
    126     public boolean repeatedKeySwitchLassoOption;
     126    private boolean repeatedKeySwitchLassoOption;
    127127
    128128    // Cache previous mouse event (needed when only the modifier keys are
Note: See TracChangeset for help on using the changeset viewer.