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

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/actions

Files:

• ChangesetManagerToggleAction.java (modified) (1 diff)
• ExtensionFileFilter.java (modified) (7 diffs)
• GpxExportAction.java (modified) (1 diff)
• JosmAction.java (modified) (3 diffs)
• PasteTagsAction.java (modified) (2 diffs)
• SplitWayAction.java (modified) (1 diff)
• UpdateSelectionAction.java (modified) (2 diffs)
• UploadAction.java (modified) (1 diff)
• downloadtasks/DownloadTask.java (modified) (3 diffs)
• mapmode/DeleteAction.java (modified) (1 diff)

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

@@ -18 +18 @@
 import org.openstreetmap.josm.tools.Shortcut;
 /**
- * This action toggles the visibility of the {@see ChangesetCacheManager} dialog.
+ * This action toggles the visibility of the {@link ChangesetCacheManager} dialog.
  *
  */

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

@@ -93 +93 @@
 
     /**
-     * Updates the {@see AllFormatsImporter} that is contained in the importers list. If
+     * Updates the {@link AllFormatsImporter} that is contained in the importers list. If
      * you do not use the importers variable directly, you don’t need to call this.
      * 
@@ -109 +109 @@
 
     /**
-     * Replies an ordered list of {@see ExtensionFileFilter}s for importing.
-     * The list is ordered according to their description, an {@see AllFormatsImporter}
+     * Replies an ordered list of {@link ExtensionFileFilter}s for importing.
+     * The list is ordered according to their description, an {@link AllFormatsImporter}
      * is append at the end.
      *
-     * @return an ordered list of {@see ExtensionFileFilter}s for importing.
+     * @return an ordered list of {@link ExtensionFileFilter}s for importing.
      */
     public static List<ExtensionFileFilter> getImportExtensionFileFilters() {
@@ -126 +126 @@
 
     /**
-     * Replies an ordered list of {@see ExtensionFileFilter}s for exporting.
-     * The list is ordered according to their description, an {@see AllFormatsImporter}
+     * Replies an ordered list of {@link ExtensionFileFilter}s for exporting.
+     * The list is ordered according to their description, an {@link AllFormatsImporter}
      * is append at the end.
      *
-     * @return an ordered list of {@see ExtensionFileFilter}s for exporting.
+     * @return an ordered list of {@link ExtensionFileFilter}s for exporting.
      */
     public static List<ExtensionFileFilter> getExportExtensionFileFilters() {
@@ -145 +145 @@
 
     /**
-     * Replies the default {@see ExtensionFileFilter} for a given extension
+     * Replies the default {@link ExtensionFileFilter} for a given extension
      *
      * @param extension the extension
-     * @return the default {@see ExtensionFileFilter} for a given extension
+     * @return the default {@link ExtensionFileFilter} for a given extension
      */
     public static ExtensionFileFilter getDefaultImportExtensionFileFilter(String extension) {
@@ -160 +160 @@
 
     /**
-     * Replies the default {@see ExtensionFileFilter} for a given extension
+     * Replies the default {@link ExtensionFileFilter} for a given extension
      *
      * @param extension the extension
-     * @return the default {@see ExtensionFileFilter} for a given extension
+     * @return the default {@link ExtensionFileFilter} for a given extension
      */
     public static ExtensionFileFilter getDefaultExportExtensionFileFilter(String extension) {
@@ -175 +175 @@
 
     /**
-     * Applies the choosable {@see FileFilter} to a {@see JFileChooser} before using the
+     * Applies the choosable {@link FileFilter} to a {@link JFileChooser} before using the
      * file chooser for selecting a file for reading.
      *
@@ -189 +189 @@
 
     /**
-     * Applies the choosable {@see FileFilter} to a {@see JFileChooser} before using the
+     * Applies the choosable {@link FileFilter} to a {@link JFileChooser} before using the
      * file chooser for selecting a file for writing.
      *

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

@@ -61 +61 @@
      *
      * <code>layer</code> must not be null. <code>layer</code> must be an instance of
-     * {@see OsmDataLayer} or {@see GpxLayer}.
+     * {@link OsmDataLayer} or {@link GpxLayer}.
      *
      * @param layer the layer
      * @exception IllegalArgumentException thrown if layer is null
-     * @exception IllegalArgumentException thrown if layer is neither an instance of {@see OsmDataLayer}
-     *  nor of {@see GpxLayer}
+     * @exception IllegalArgumentException thrown if layer is neither an instance of {@link OsmDataLayer}
+     *  nor of {@link GpxLayer}
      */
     public void export(Layer layer) {

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

@@ -24 +24 @@
  * Base class helper for all Actions in JOSM. Just to make the life easier.
  *
- * A JosmAction is a {@see LayerChangeListener} and a {@see SelectionChangedListener}. Upon
- * a layer change event or a selection change event it invokes {@see #updateEnabled()}.
- * Subclasses can override {@see #updateEnabled()} in order to update the {@see #isEnabled()}-state
- * of a JosmAction depending on the {@see #getCurrentDataSet()} and the current layers
- * (see also {@see #getEditLayer()}).
+ * A JosmAction is a {@link LayerChangeListener} and a {@link SelectionChangedListener}. Upon
+ * a layer change event or a selection change event it invokes {@link #updateEnabled()}.
+ * Subclasses can override {@link #updateEnabled()} in order to update the {@link #isEnabled()}-state
+ * of a JosmAction depending on the {@link #getCurrentDataSet()} and the current layers
+ * (see also {@link #getEditLayer()}).
  *
  * destroy() from interface Destroyable is called e.g. for MapModes, when the last layer has
@@ -179 +179 @@
     /**
      * Override in subclasses to init the enabled state of an action when it is
-     * created. Default behaviour is to call {@see #updateEnabledState()}
+     * created. Default behaviour is to call {@link #updateEnabledState()}
      *
      * @see #updateEnabledState()
@@ -192 +192 @@
      * something in the JOSM state changes, i.e. when a layer is removed or added.
      *
-     * See {@see #updateEnabledState(Collection)} to respond to changes in the collection
+     * See {@link #updateEnabledState(Collection)} to respond to changes in the collection
      * of selected primitives.
      *

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

@@ -53 +53 @@
         /**
          * Replies true if the source for tag pasting is heterogeneous, i.e. if it doesn't consist of
-         * {@see OsmPrimitive}s of exactly one type
+         * {@link OsmPrimitive}s of exactly one type
          *
          * @return
@@ -130 +130 @@
 
         /**
-         * Pastes the tags from a homogeneous source (i.e. the {@see Main#pasteBuffer}s selection consisting
-         * of one type of {@see OsmPrimitive}s only.
+         * Pastes the tags from a homogeneous source (i.e. the {@link Main#pasteBuffer}s selection consisting
+         * of one type of {@link OsmPrimitive}s only.
          *
          * Tags from a homogeneous source can be pasted to a heterogeneous target. All target primitives,

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

@@ -468 +468 @@
     /**
      * Splits the way {@code way} at the nodes in {@code atNodes} and replies
-     * the result of this process in an instance of {@see SplitWayResult}.
+     * the result of this process in an instance of {@link SplitWayResult}.
      *
      * Note that changes are not applied to the data yet. You have to
-     * submit the command in {@see SplitWayResult#getCommand()} first,
+     * submit the command in {@link SplitWayResult#getCommand()} first,
      * i.e. {@code Main.main.undoredo.add(result.getCommand())}.
      *

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

@@ -47 +47 @@
 
     /**
-     * Updates the data for for the {@see OsmPrimitive}s in <code>selection</code>
+     * Updates the data for for the {@link OsmPrimitive}s in <code>selection</code>
      * with the data currently kept on the server.
      *
-     * @param selection a collection of {@see OsmPrimitive}s to update
+     * @param selection a collection of {@link OsmPrimitive}s to update
      *
      */
@@ -59 +59 @@
 
     /**
-     * Updates the data for  the {@see OsmPrimitive}s with id <code>id</code>
+     * Updates the data for  the {@link OsmPrimitive}s with id <code>id</code>
      * with the data currently kept on the server.
      *
-     * @param id  the id of a primitive in the {@see DataSet} of the current edit layer. Must not be null.
+     * @param id  the id of a primitive in the {@link DataSet} of the current edit layer. Must not be null.
      * @throws IllegalArgumentException thrown if id is null
      * @exception IllegalStateException thrown if there is no primitive with <code>id</code> in

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

@@ -136 +136 @@
      * Check whether the preconditions are met to upload data in <code>apiData</code>.
      * Makes sure upload is allowed, primitives in <code>apiData</code> don't participate in conflicts and
-     * runs the installed {@see UploadHook}s.
+     * runs the installed {@link UploadHook}s.
      *
      * @param layer the source layer of the data to be uploaded

trunk/src/org/openstreetmap/josm/actions/downloadtasks/DownloadTask.java

@@ -13 +13 @@
      *
      * Set <code>progressMonitor</code> to null, if the task should create, open, and close a progress monitor.
-     * Set progressMonitor to {@see NullProgressMonitor#INSTANCE} if progress information is to
+     * Set progressMonitor to {@link NullProgressMonitor#INSTANCE} if progress information is to
      * be discarded.
      *
      * You can wait for the asynchronous download task to finish by synchronizing on the returned
-     * {@see Future}, but make sure not to freeze up JOSM. Example:
+     * {@link Future}, but make sure not to freeze up JOSM. Example:
      * <pre>
      *    Future<?> future = task.download(...);
@@ -53 +53 @@
      *
      * Set progressMonitor to null, if the task should create, open, and close a progress monitor.
-     * Set progressMonitor to {@see NullProgressMonitor#INSTANCE} if progress information is to
+     * Set progressMonitor to {@link NullProgressMonitor#INSTANCE} if progress information is to
      * be discarded.
 
@@ -76 +76 @@
      * Replies the error objects of the task. Empty list, if no error messages are available.
      *
-     * Error objects are either {@see String}s with error messages or {@see Exception}s.
+     * Error objects are either {@link String}s with error messages or {@link Exception}s.
      *
      * @return the list of error objects

trunk/src/org/openstreetmap/josm/actions/mapmode/DeleteAction.java

@@ -331 +331 @@
     /**
      * Deletes the relation in the context of the given layer. Also notifies
-     * {@see RelationDialogManager} and {@see OsmDataLayer#fireDataChange()} events.
+     * {@link RelationDialogManager} and {@link OsmDataLayer#fireDataChange()} events.
      *
      * @param layer the layer in whose context the relation is deleted. Must not be null.