Changeset 12581 in josm


Ignore:
Timestamp:
2017-08-08T15:13:27+02:00 (12 days ago)
Author:
bastiK
Message:

see #14794 - javadoc

Location:
trunk/src/org/openstreetmap/josm
Files:
14 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/org/openstreetmap/josm/actions/CloseChangesetAction.java

    r10938 r12581  
    3030import org.xml.sax.SAXException;
    3131
     32/**
     33 * User action to close open changesets.
     34 *
     35 * The list of open changesets will be downloaded from the server and presented
     36 * to the user.
     37 */
    3238public class CloseChangesetAction extends JosmAction {
    3339
  • trunk/src/org/openstreetmap/josm/actions/CopyCoordinatesAction.java

    r12314 r12581  
    1515import org.openstreetmap.josm.tools.Shortcut;
    1616
     17/**
     18 * User action to copy the coordinates of one or several node(s) to the clipboard.
     19 */
    1720public class CopyCoordinatesAction extends JosmAction {
    1821
  • trunk/src/org/openstreetmap/josm/actions/PreferenceToggleAction.java

    r10874 r12581  
    99import org.openstreetmap.josm.data.preferences.BooleanProperty;
    1010
     11/**
     12 * User action to toggle a custom boolean preference value.
     13 *
     14 * A user action will just change a preference value. To take any real action,
     15 * register another {@link PreferenceChangedListener} for the given preference key.
     16 */
    1117public class PreferenceToggleAction extends JosmAction implements PreferenceChangedListener {
    1218
     
    1420    private final BooleanProperty pref;
    1521
     22    /**
     23     * Create a new PreferenceToggleAction.
     24     * @param name the (translated) title
     25     * @param tooltip tooltip text
     26     * @param prefKey the preference key to toggle
     27     * @param prefDefault default value for the preference entry
     28     */
    1629    public PreferenceToggleAction(String name, String tooltip, String prefKey, boolean prefDefault) {
    1730        super(name, null, tooltip, null, false);
  • trunk/src/org/openstreetmap/josm/actions/SelectAllAction.java

    r10711 r12581  
    1212import org.openstreetmap.josm.tools.Shortcut;
    1313
     14/**
     15 * User action to select all primitives in the current dataset.
     16 */
    1417public class SelectAllAction extends JosmAction {
    1518
  • trunk/src/org/openstreetmap/josm/actions/ShowStatusReportAction.java

    r12279 r12581  
    4444
    4545/**
     46 * Opens a dialog with useful status information like version numbers for Java, JOSM and plugins
     47 * Also includes preferences with stripped username and password.
     48 *
    4649 * @author xeen
    47  *
    48  * Opens a dialog with useful status information like version numbers for Java, JOSM and plugins
    49  * Also includes preferences with stripped username and password
    5050 */
    5151public final class ShowStatusReportAction extends JosmAction {
  • trunk/src/org/openstreetmap/josm/actions/UnselectAllAction.java

    r10382 r12581  
    1010import org.openstreetmap.josm.tools.Shortcut;
    1111
     12/**
     13 * User action to clear the current selection.
     14 */
    1215public class UnselectAllAction extends JosmAction {
    1316
  • trunk/src/org/openstreetmap/josm/actions/UpdateDataAction.java

    r11627 r12581  
    2020import org.openstreetmap.josm.tools.Shortcut;
    2121
     22/**
     23 * This action synchronizes the dataset with the current state on the server.
     24 *
     25 * It does so by re-downloading all areas and thereby merging all compatible
     26 * changes from the current server version.
     27 */
    2228public class UpdateDataAction extends JosmAction {
    2329
  • trunk/src/org/openstreetmap/josm/actions/ZoomToAction.java

    r12366 r12581  
    2626
    2727/**
    28  * An action that zooms to the selected OSM primitive in a table of primitives
     28 * An action that zooms to the selected OSM primitive in a table of primitives.
    2929 */
    3030public class ZoomToAction extends AbstractAction implements LayerChangeListener, ActiveLayerChangeListener, ListSelectionListener {
  • trunk/src/org/openstreetmap/josm/actions/mapmode/DrawSnapHelper.java

    r12131 r12581  
    3232import org.openstreetmap.josm.tools.Utils;
    3333
     34/**
     35 * Class that enables the user to draw way segments in angles of exactly 30, 45,
     36 * 60, 90 degrees.
     37 *
     38 * With enabled snapping, the new way node will be projected onto the helper line
     39 * that indicates a certain fixed angle relative to the previous segment.
     40 */
    3441class DrawSnapHelper {
    3542
  • trunk/src/org/openstreetmap/josm/actions/mapmode/ImproveWayAccuracyAction.java

    r12517 r12581  
    5252
    5353/**
     54 * A special map mode that is optimized for improving way geometry.
     55 * (by efficiently moving, adding and deleting way-nodes)
     56 *
    5457 * @author Alexander Kachkaev <alexander@kachkaev.ru>, 2011
    5558 */
  • trunk/src/org/openstreetmap/josm/actions/mapmode/ParallelWayAction.java

    r12517 r12581  
    5353import org.openstreetmap.josm.tools.Shortcut;
    5454
    55 //// TODO: (list below)
    56 /* == Functionality ==
     55/**
     56 * MapMode for making parallel ways.
     57 *
     58 * All calculations are done in projected coordinates.
     59 *
     60 * TODO:
     61 * == Functionality ==
    5762 *
    5863 * 1. Use selected nodes as split points for the selected ways.
     
    8186 * Current code doesn't not take into account that ways might been highlighted
    8287 * by other than us. Don't think that situation should ever happen though.
    83  */
    84 
    85 /**
    86  * MapMode for making parallel ways.
    87  *
    88  * All calculations are done in projected coordinates.
    8988 *
    9089 * @author Ole Jørgen Brønner (olejorgenb)
  • trunk/src/org/openstreetmap/josm/actions/upload/ApiPreconditionCheckerHook.java

    r10463 r12581  
    2020import org.openstreetmap.josm.io.OsmTransferCanceledException;
    2121
     22/**
     23 * Checks certain basic conditions, that are listed in the OSM API
     24 * {@link org.openstreetmap.josm.io.Capabilities}.
     25 */
    2226public class ApiPreconditionCheckerHook implements UploadHook {
    2327
  • trunk/src/org/openstreetmap/josm/actions/upload/UploadHook.java

    r10600 r12581  
    44import org.openstreetmap.josm.data.APIDataSet;
    55
     6/**
     7 * A check right before the upload. The UploadHook may modify the uploaded data
     8 * silently, it may display a warning message to the user or prevent the upload
     9 * altogether.
     10 */
    611@FunctionalInterface
    712public interface UploadHook {
  • trunk/src/org/openstreetmap/josm/command/ScaleCommand.java

    r10663 r12581  
    1111import org.openstreetmap.josm.data.osm.OsmPrimitive;
    1212
     13/**
     14 * Command, to scale a given set of primitives.
     15 * The relative distance of the nodes will be increased/decreased.
     16 */
    1317public class ScaleCommand extends TransformNodesCommand {
    1418    /**
Note: See TracChangeset for help on using the changeset viewer.