Changeset 5836 in josm for trunk/src/org/openstreetmap/josm/plugins

Timestamp:

2013-04-07T23:18:22+02:00 (12 years ago)

Author:

stoecker

Message:

javadoc fixes

Location:

trunk/src/org/openstreetmap/josm/plugins

Files:

• Plugin.java (modified) (1 diff)
• PluginDownloadTask.java (modified) (3 diffs)
• PluginInformation.java (modified) (1 diff)
• ReadLocalPluginInformationTask.java (modified) (1 diff)
• ReadRemotePluginInformationTask.java (modified) (1 diff)

trunk/src/org/openstreetmap/josm/plugins/Plugin.java

@@ -69 +69 @@
      * Sets the plugin information object for this plugin
      *
-     * @parma info the plugin information object
+     * @param info the plugin information object
      */
     public void setPluginInformation(PluginInformation info) {

trunk/src/org/openstreetmap/josm/plugins/PluginDownloadTask.java

@@ -45 +45 @@
      * Creates the download task
      *
-     * @param parent the parent component relative to which the {@link PleaseWaitDialog} is displayed
+     * @param parent the parent component relative to which the {@link org.openstreetmap.josm.gui.PleaseWaitDialog} is displayed
      * @param toUpdate a collection of plugin descriptions for plugins to update/download. Must not be null.
-     * @param title the title to display in the {@link PleaseWaitDialog}
+     * @param title the title to display in the {@link org.openstreetmap.josm.gui.PleaseWaitDialog}
      * @throws IllegalArgumentException thrown if toUpdate is null
      */
@@ -61 +61 @@
      * @param monitor a progress monitor. Defaults to {@link NullProgressMonitor#INSTANCE} if null
      * @param toUpdate a collection of plugin descriptions for plugins to update/download. Must not be null.
-     * @param title the title to display in the {@link PleaseWaitDialog}
+     * @param title the title to display in the {@link org.openstreetmap.josm.gui.PleaseWaitDialog}
      * @throws IllegalArgumentException thrown if toUpdate is null
      */
@@ -178 +178 @@
      * Replies true if the task was canceled by the user
      *
-     * @return
+     * @return <code>true</code> if the task was stopped by the user
      */
     public boolean isCanceled() {

trunk/src/org/openstreetmap/josm/plugins/PluginInformation.java

@@ -294 +294 @@
      * Load and instantiate the plugin
      *
-     * @param the plugin class
+     * @param klass the plugin class
      * @return the instantiated and initialized plugin
      */

trunk/src/org/openstreetmap/josm/plugins/ReadLocalPluginInformationTask.java

@@ -25 +25 @@
  * in the local plugin repositories.
  *
- * It scans the files in the local plugins repository (see {@link Preferences#getPluginsDirectory()}
+ * It scans the files in the local plugins repository (see {@link org.openstreetmap.josm.data.Preferences#getPluginsDirectory()}
  * and extracts plugin information from three kind of files:
  * <ul>

trunk/src/org/openstreetmap/josm/plugins/ReadRemotePluginInformationTask.java

@@ -372 +372 @@
     /**
      * Replies true if the task was canceled
-     * @return
+     * @return <code>true</code> if the task was stopped by the user
      */
     public boolean isCanceled() {