Changeset 13106 in josm

Timestamp:

2017-11-10T01:11:04+01:00 (7 years ago)

Author:

Don-vip

Message:

add some javadoc

Location:

trunk/src/org/openstreetmap/josm

Files:

• actions/AlignInCircleAction.java (modified) (1 diff)
• actions/CopyCoordinatesAction.java (modified) (1 diff)
• actions/DownloadPrimitiveAction.java (modified) (3 diffs)
• actions/ExpertToggleAction.java (modified) (2 diffs)
• gui/dialogs/MenuItemSearchDialog.java (modified) (1 diff)

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

@@ -87 +87 @@
         }
 
+        /**
+         * Converts this {@code PolarCoor} to an {@link EastNorth} instance.
+         * @return a new {@code EastNorth} instance
+         */
         public EastNorth toEastNorth() {
             return new EastNorth(radius * Math.cos(angle - azimuth) + origin.east(), radius * Math.sin(angle - azimuth)

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

@@ -20 +20 @@
 public class CopyCoordinatesAction extends JosmAction {
 
+    /**
+     * Constructs a new {@code CopyCoordinatesAction}.
+     */
     public CopyCoordinatesAction() {
         super(tr("Copy Coordinates"), null,

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

@@ -23 +23 @@
 public class DownloadPrimitiveAction extends JosmAction {
 
+    /**
+     * Action shortcut (ctrl-shift-O by default), made public in order to be used from {@code GettingStarted} page.
+     */
     public static final Shortcut SHORTCUT = Shortcut.registerShortcut("system:download_primitive", tr("File: {0}", tr("Download object...")),
             KeyEvent.VK_O, Shortcut.CTRL_SHIFT);
@@ -37 +40 @@
     @Override
     public void actionPerformed(ActionEvent e) {
-
         DownloadObjectDialog dialog = new DownloadObjectDialog();
         if (dialog.showDialog().getValue() != dialog.getContinueButtonIndex()) return;
@@ -45 +47 @@
 
     /**
+     * Submits the download task for the given primitive ids.
      * @param newLayer if the data should be downloaded into a new layer
      * @param ids List of primitive id to download

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

@@ -43 +43 @@
 
     /**
-     * Register a expert mode change listener
+     * Register a expert mode change listener.
      *
      * @param listener the listener. Ignored if null.
@@ -51 +51 @@
     }
 
+    /**
+     * Register a expert mode change listener, and optionnally fires it.
+     * @param listener the listener. Ignored if null.
+     * @param fireWhenAdding if true, the listener will be fired immediately after added
+     */
     public static synchronized void addExpertModeChangeListener(ExpertModeChangeListener listener, boolean fireWhenAdding) {
         if (listener == null) return;

trunk/src/org/openstreetmap/josm/gui/dialogs/MenuItemSearchDialog.java

@@ -120 +120 @@
 
         // CHECKSTYLE.OFF: LineLength
-        /** Action shortcut (ctrl / space by default */
+        /** Action shortcut (ctrl / space by default), made public in order to be used from {@code GettingStarted} page. */
         public static final Shortcut SHORTCUT = Shortcut.registerShortcut("help:search-items", "Search menu items", KeyEvent.VK_SPACE, Shortcut.CTRL);
         // CHECKSTYLE.ON: LineLength