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

Timestamp:

2018-04-08T15:24:48+02:00 (7 years ago)

Author:

donvip

Message:

fix javadoc warnings

Location:

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

Files:

• io/geographic/MifReader.java (modified) (1 diff)
• modules/ModuleHandler.java (modified) (7 diffs)
• modules/ModuleInformation.java (modified) (3 diffs)

applications/editors/josm/plugins/opendata/src/org/openstreetmap/josm/plugins/opendata/core/io/geographic/MifReader.java

@@ -619 +619 @@
     }
 
-    /** Compare two doubles within a default epsilon */
+    /**
+     * Compare two doubles within a default epsilon
+     * @param a first double
+     * @param b second double
+     * @return {@code true} if {@code a} and {@code b} are equals
+     */
     public static boolean equals(Double a, Double b) {
         if (a == b) return true;

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

@@ -187 +187 @@
      * depends on should be missing.
      *
+     * @param parent parent component
      * @param modules the collection of all loaded modules
      * @param module the module for which preconditions are checked
@@ -198 +199 @@
      * Creates a class loader for loading module code.
      *
-     * @param modules the collection of modules which are going to be loaded with this
-     * class loader
+     * @param modules the collection of modules which are going to be loaded with this class loader
      * @return the class loader
      */
@@ -225 +225 @@
      * the class loader <code>moduleClassLoader</code>.
      *
+     * @param parent parent component
      * @param module the module
      * @param moduleClassLoader the module class loader
@@ -262 +263 @@
 
     /**
-     * Loads the module in <code>modules</code> from locally available jar files into
-     * memory.
-     *
+     * Loads the module in <code>modules</code> from locally available jar files into memory.
+     *
+     * @param parent parent component
      * @param modules the list of modules
      * @param monitor the progress monitor. Defaults to {@link NullProgressMonitor#INSTANCE} if null.
@@ -356 +357 @@
     /**
      * Builds the set of modules to load. Deprecated and unmaintained modules are filtered
-     * out. This involves user interaction. This method displays alert and confirmation
-     * messages.
-     *
+     * out. This involves user interaction. This method displays alert and confirmation messages.
+     *
+     * @param parent parent component
      * @return the set of modules to load (as set of module names)
      */
@@ -417 +418 @@
      * @param modules the collection of modules to update. Must not be null.
      * @param monitor the progress monitor. Defaults to {@link NullProgressMonitor#INSTANCE} if null.
+     * @return list of modules
      * @throws IllegalArgumentException thrown if modules is null
      */
@@ -499 +501 @@
      * Ask the user for confirmation that a module shall be disabled.
      *
+     * @param parent parent component
      * @param reason the reason for disabling the module
      * @param name the module name

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

@@ -223 +223 @@
      * @param klass the module class
      * @return the instantiated and initialized module
+     * @throws ModuleException if the module cannot be loaded or initialized
      */
     public Module load(Class<? extends Module> klass) throws ModuleException {
@@ -237 +238 @@
      * @param classLoader the class loader to use
      * @return the loaded class
+     * @throws ModuleException if the class cannot be found
      */
     @SuppressWarnings("unchecked")
@@ -326 +328 @@
     /**
      * Replies the name of the module
+     * @return the name of the module
      */
     public String getName() {