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

Timestamp:

2012-06-03T16:41:25+02:00 (12 years ago)

Author:

bastiK

Message:

fixed majority of javadoc warnings by replacing "{@see" by "{@link"

Location:

trunk/src/org/openstreetmap/josm/plugins

Files:

• PluginDownloadTask.java (modified) (3 diffs)
• PluginHandler.java (modified) (6 diffs)
• ReadLocalPluginInformationTask.java (modified) (1 diff)
• ReadRemotePluginInformationTask.java (modified) (1 diff)

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

@@ -30 +30 @@
  * Asynchronous task for downloading a collection of plugins.
  *
- * When the task is finished {@see #getDownloadedPlugins()} replies the list of downloaded plugins
- * and {@see #getFailedPlugins()} replies the list of failed plugins.
+ * When the task is finished {@link #getDownloadedPlugins()} replies the list of downloaded plugins
+ * and {@link #getFailedPlugins()} replies the list of failed plugins.
  *
  */
@@ -45 +45 @@
      * 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 plugin descriptions for plugins 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
      */
@@ -59 +59 @@
      * 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 plugin descriptions for plugins 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
      */

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

@@ -519 +519 @@
      *
      * @param plugins the list of plugins
-     * @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 loadPlugins(Component parent,Collection<PluginInformation> plugins, ProgressMonitor monitor) {
@@ -564 +564 @@
 
     /**
-     * Loads plugins from <code>plugins</code> which have the flag {@see PluginInformation#early}
+     * Loads plugins from <code>plugins</code> which have the flag {@link PluginInformation#early}
      * set to true.
      *
      * @param plugins the collection of plugins
-     * @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 loadEarlyPlugins(Component parent, Collection<PluginInformation> plugins, ProgressMonitor monitor) {
@@ -581 +581 @@
 
     /**
-     * Loads plugins from <code>plugins</code> which have the flag {@see PluginInformation#early}
+     * Loads plugins from <code>plugins</code> which have the flag {@link PluginInformation#early}
      * set to false.
      *
      * @param plugins the collection of plugins
-     * @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 loadLatePlugins(Component parent, Collection<PluginInformation> plugins, ProgressMonitor monitor) {
@@ -601 +601 @@
      * plugin 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 plugin information
      *
@@ -661 +661 @@
      * messages.
      *
-     * @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 set of plugins to load (as set of plugin names)
      */
@@ -731 +731 @@
      * @param parent the parent component for message boxes
      * @param plugins the collection of plugins 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 plugins is null
      */

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 {@see Preferences#getPluginsDirectory()}
+ * It scans the files in the local plugins repository (see {@link Preferences#getPluginsDirectory()}
  * and extracts plugin information from three kind of files:
  * <ul>

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

@@ -72 +72 @@
      * 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.
      */