Changeset 34151 in osm for applications/editors/josm/plugins/opendata/src/org

Timestamp:

2018-04-08T15:09:55+02:00 (7 years ago)

Author:

donvip

Message:

fix javadoc warnings

Location:

applications/editors/josm/plugins/opendata/src/org/openstreetmap/josm/plugins/opendata/core/modules

Files:

• ModuleDownloadTask.java (modified) (4 diffs)
• ModuleHandler.java (modified) (5 diffs)
• ModuleInformation.java (modified) (1 diff)
• ReadLocalModuleInformationTask.java (modified) (2 diffs)
• ReadRemoteModuleInformationTask.java (modified) (1 diff)

applications/editors/josm/plugins/opendata/src/org/openstreetmap/josm/plugins/opendata/core/modules/ModuleDownloadTask.java

@@ -17 +17 @@
 
 import org.openstreetmap.josm.data.Version;
+import org.openstreetmap.josm.gui.PleaseWaitDialog;
 import org.openstreetmap.josm.gui.PleaseWaitRunnable;
 import org.openstreetmap.josm.gui.progress.NullProgressMonitor;
@@ -28 +29 @@
  * Asynchronous task for downloading a collection of modules.
  *
- * When the task is finished {@see #getDownloadedModules()} replies the list of downloaded modules
- * and {@see #getFailedModules()} replies the list of failed modules.
+ * When the task is finished {@link #getDownloadedModules()} replies the list of downloaded modules
+ * and {@link #getFailedModules()} replies the list of failed modules.
  *
  */
@@ -43 +44 @@
      * Creates the download task
      *
-     * @param parent the parent component relative to which the {@see PleaseWaitDialog} is displayed
+     * @param parent the parent component relative to which the {@link PleaseWaitDialog} is displayed
      * @param toUpdate a collection of module descriptions for modules to update/download. Must not be null.
-     * @param title the title to display in the {@see PleaseWaitDialog}
+     * @param title the title to display in the {@link PleaseWaitDialog}
      * @throws IllegalArgumentException thrown if toUpdate is null
      */
@@ -57 +58 @@
      * Creates the task
      *
-     * @param monitor a progress monitor. Defaults to {@see NullProgressMonitor#INSTANCE} if null
+     * @param monitor a progress monitor. Defaults to {@link NullProgressMonitor#INSTANCE} if null
      * @param toUpdate a collection of module descriptions for modules to update/download. Must not be null.
-     * @param title the title to display in the {@see PleaseWaitDialog}
+     * @param title the title to display in the {@link PleaseWaitDialog}
      * @throws IllegalArgumentException thrown if toUpdate is null
      */

applications/editors/josm/plugins/opendata/src/org/openstreetmap/josm/plugins/opendata/core/modules/ModuleHandler.java

@@ -266 +266 @@
      *
      * @param modules the list of modules
-     * @param monitor the progress monitor. Defaults to {@see NullProgressMonitor#INSTANCE} if null.
+     * @param monitor the progress monitor. Defaults to {@link NullProgressMonitor#INSTANCE} if null.
      */
     public static void loadModules(Component parent, Collection<ModuleInformation> modules, ProgressMonitor monitor) {
@@ -302 +302 @@
      * module lists.
      *
-     * @param monitor the progress monitor. Defaults to {@see NullProgressMonitor#INSTANCE} if null.
+     * @param monitor the progress monitor. Defaults to {@link NullProgressMonitor#INSTANCE} if null.
      * @return the list of locally available module information
      *
@@ -416 +416 @@
      * @param parent the parent window for message boxes
      * @param modules the collection of modules to update. Must not be null.
-     * @param monitor the progress monitor. Defaults to {@see NullProgressMonitor#INSTANCE} if null.
+     * @param monitor the progress monitor. Defaults to {@link NullProgressMonitor#INSTANCE} if null.
      * @throws IllegalArgumentException thrown if modules is null
      */
@@ -622 +622 @@
     }*/
 
-    /**
+    /*
      * Replies the module which most likely threw the exception <code>ex</code>.
      *
@@ -647 +647 @@
     }*/
 
-    /**
+    /*
      * Checks whether the exception <code>e</code> was thrown by a module. If so,
      * conditionally deactivates the module, but asks the user first.

applications/editors/josm/plugins/opendata/src/org/openstreetmap/josm/plugins/opendata/core/modules/ModuleInformation.java

@@ -221 +221 @@
      * Load and instantiate the module
      *
-     * @param the module class
+     * @param klass the module class
      * @return the instantiated and initialized module
      */

applications/editors/josm/plugins/opendata/src/org/openstreetmap/josm/plugins/opendata/core/modules/ReadLocalModuleInformationTask.java

@@ -17 +17 @@
 import org.openstreetmap.josm.gui.progress.ProgressMonitor;
 import org.openstreetmap.josm.io.OsmTransferException;
+import org.openstreetmap.josm.plugins.opendata.OdPlugin;
 import org.openstreetmap.josm.tools.ImageProvider;
 import org.openstreetmap.josm.tools.Logging;
@@ -25 +26 @@
  * in the local module repositories.
  *
- * It scans the files in the local modules repository (see {@see Preferences#getModulesDirectory()}
+ * It scans the files in the local modules repository (see {@link OdPlugin#getModulesDirectory()}
  * and extracts module information from three kind of files:
  * <ul>

applications/editors/josm/plugins/opendata/src/org/openstreetmap/josm/plugins/opendata/core/modules/ReadRemoteModuleInformationTask.java

@@ -69 +69 @@
      * Creates the task
      *
-     * @param monitor the progress monitor. Defaults to {@see NullProgressMonitor#INSTANCE} if null
+     * @param monitor the progress monitor. Defaults to {@link NullProgressMonitor#INSTANCE} if null
      * @param sites the collection of download sites. Defaults to the empty collection if null.
      */