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

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

Files:

• ChangesetClosedException.java (modified) (2 diffs)
• ChangesetQuery.java (modified) (3 diffs)
• DefaultProxySelector.java (modified) (2 diffs)
• DiffResultProcessor.java (modified) (2 diffs)
• MultiFetchServerObjectReader.java (modified) (18 diffs)
• OsmApi.java (modified) (4 diffs)
• OsmChangeReader.java (modified) (1 diff)
• OsmChangesetContentParser.java (modified) (1 diff)
• OsmHistoryReader.java (modified) (1 diff)
• OsmReader.java (modified) (1 diff)
• OsmServerBackreferenceReader.java (modified) (6 diffs)
• OsmServerChangesetReader.java (modified) (5 diffs)
• OsmServerHistoryReader.java (modified) (1 diff)
• OsmServerObjectReader.java (modified) (1 diff)
• OsmServerWriter.java (modified) (1 diff)
• auth/CredentialsAgent.java (modified) (4 diffs)
• auth/CredentialsAgentResponse.java (modified) (1 diff)
• auth/CredentialsManager.java (modified) (1 diff)
• auth/DefaultAuthenticator.java (modified) (1 diff)

trunk/src/org/openstreetmap/josm/io/ChangesetClosedException.java

@@ -14 +14 @@
 /**
  * A ChangesetClosedException is thrown if the server replies with a HTTP
- * return code 409 (Conflict) with the error header {@see #ERROR_HEADER_PATTERN}.
+ * return code 409 (Conflict) with the error header {@link #ERROR_HEADER_PATTERN}.
  *
  * Depending on the context the exception is thrown in we have to react differently.
@@ -50 +50 @@
 
     /**
-     * Replies true if <code>errorHeader</code> matches with {@see #ERROR_HEADER_PATTERN}
+     * Replies true if <code>errorHeader</code> matches with {@link #ERROR_HEADER_PATTERN}
      *
      * @param errorHeader the error header
-     * @return true if <code>errorHeader</code> matches with {@see #ERROR_HEADER_PATTERN}
+     * @return true if <code>errorHeader</code> matches with {@link #ERROR_HEADER_PATTERN}
      */
     static public boolean errorHeaderMatchesPattern(String errorHeader) {

trunk/src/org/openstreetmap/josm/io/ChangesetQuery.java

@@ -67 +67 @@
      *
      * Caveat: for historical reasons the username might not be unique! It is recommended to use
-     * {@see #forUser(int)} to restrict the query to a specific user.
+     * {@link #forUser(int)} to restrict the query to a specific user.
      *
      * @param username the username. Must not be null.
@@ -94 +94 @@
     /**
      * Replies the user name which this query is restricted to. null, if this query isn't
-     * restricted to a user name, i.e. if {@see #isRestrictedToPartiallyIdentifiedUser()} is false.
+     * restricted to a user name, i.e. if {@link #isRestrictedToPartiallyIdentifiedUser()} is false.
      *
      * @return the user name which this query is restricted to
@@ -406 +406 @@
         /**
          * Parses the changeset query given as URL query parameters and replies a
-         * {@see ChangesetQuery}
+         * {@link ChangesetQuery}
          *
          * <code>query</code> is the query part of a API url for querying changesets,

trunk/src/org/openstreetmap/josm/io/DefaultProxySelector.java

@@ -24 +24 @@
 public class DefaultProxySelector extends ProxySelector {
     /**
-     * The {@see ProxySelector} provided by the JDK will retrieve proxy information
+     * The {@link ProxySelector} provided by the JDK will retrieve proxy information
      * from the system settings, if the system property <tt>java.net.useSystemProxies</tt>
      * is defined <strong>at startup</strong>. It has no effect if the property is set
@@ -40 +40 @@
 
     /**
-     * The {@see ProxySelector} provided by the JDK will retrieve proxy information
+     * The {@link ProxySelector} provided by the JDK will retrieve proxy information
      * from the system settings, if the system property <tt>java.net.useSystemProxies</tt>
      * is defined <strong>at startup</strong>. If the property is set later by the application,

trunk/src/org/openstreetmap/josm/io/DiffResultProcessor.java

@@ -70 +70 @@
      *
      * @param diffUploadResponse the response. Must not be null.
-     * @param progressMonitor a progress monitor. Defaults to {@see NullProgressMonitor#INSTANCE} if null
+     * @param progressMonitor a progress monitor. Defaults to {@link NullProgressMonitor#INSTANCE} if null
      * @throws IllegalArgumentException thrown if diffUploadRequest is null
      * @throws OsmDataParsingException thrown if the diffUploadRequest can't be parsed successfully
@@ -105 +105 @@
      *
      * @param cs the current changeset. Ignored if null.
-     * @param monitor the progress monitor. Set to {@see NullProgressMonitor#INSTANCE} if null
+     * @param monitor the progress monitor. Set to {@link NullProgressMonitor#INSTANCE} if null
      * @return the collection of processed primitives
      */

trunk/src/org/openstreetmap/josm/io/MultiFetchServerObjectReader.java

@@ -29 +29 @@
 
 /**
- * Retrieves a set of {@see OsmPrimitive}s from an OSM server using the so called
+ * Retrieves a set of {@link OsmPrimitive}s from an OSM server using the so called
  * Multi Fetch API.
  *
@@ -77 +77 @@
 
     /**
-     * Remembers an {@see OsmPrimitive}'s id. The id will
+     * Remembers an {@link OsmPrimitive}'s id. The id will
      * later be fetched as part of a Multi Get request.
      *
@@ -94 +94 @@
 
     /**
-     * remembers an {@see OsmPrimitive}'s id. <code>ds</code> must include
-     * an {@see OsmPrimitive} with id=<code>id</code>. The id will
+     * remembers an {@link OsmPrimitive}'s id. <code>ds</code> must include
+     * an {@link OsmPrimitive} with id=<code>id</code>. The id will
      * later we fetched as part of a Multi Get request.
      *
@@ -103 +103 @@
      * @param id  the id
      * @exception IllegalArgumentException thrown, if ds is null
-     * @exception NoSuchElementException thrown, if ds doesn't include an {@see OsmPrimitive} with
+     * @exception NoSuchElementException thrown, if ds doesn't include an {@link OsmPrimitive} with
      *   id=<code>id</code>
      */
@@ -135 +135 @@
 
     /**
-     * appends a {@see Node}s id to the list of ids which will be fetched from the server.
+     * appends a {@link Node}s id to the list of ids which will be fetched from the server.
      *
      * @param node  the node (ignored, if null)
@@ -148 +148 @@
 
     /**
-     * appends a {@see Way}s id and the list of ids of nodes the way refers to the list of ids which will be fetched from the server.
+     * appends a {@link Way}s id and the list of ids of nodes the way refers to the list of ids which will be fetched from the server.
      *
      * @param way the way (ignored, if null)
@@ -167 +167 @@
 
     /**
-     * appends a {@see Relation}s id to the list of ids which will be fetched from the server.
+     * appends a {@link Relation}s id to the list of ids which will be fetched from the server.
      *
      * @param relation  the relation (ignored, if null)
@@ -204 +204 @@
 
     /**
-     * appends a list of {@see OsmPrimitive} to the list of ids which will be fetched from the server.
+     * appends a list of {@link OsmPrimitive} to the list of ids which will be fetched from the server.
      *
      * @param primitives  the list of primitives (ignored, if null)
@@ -223 +223 @@
 
     /**
-     * extracts a subset of max {@see #MAX_IDS_PER_REQUEST} ids from <code>ids</code> and
+     * extracts a subset of max {@link #MAX_IDS_PER_REQUEST} ids from <code>ids</code> and
      * replies the subset. The extracted subset is removed from <code>ids</code>.
      *
@@ -248 +248 @@
     /**
      * builds the Multi Get request string for a set of ids and a given
-     * {@see OsmPrimitiveType}.
+     * {@link OsmPrimitiveType}.
      *
      * @param type the type
@@ -271 +271 @@
     /**
      * builds the Multi Get request string for a single id and a given
-     * {@see OsmPrimitiveType}.
+     * {@link OsmPrimitiveType}.
      *
      * @param type the type
@@ -286 +286 @@
 
     /**
-     * invokes a Multi Get for a set of ids and a given {@see OsmPrimitiveType}.
-     * The retrieved primitives are merged to {@see #outputDataSet}.
+     * invokes a Multi Get for a set of ids and a given {@link OsmPrimitiveType}.
+     * The retrieved primitives are merged to {@link #outputDataSet}.
      *
      * @param type the type
@@ -309 +309 @@
 
     /**
-     * invokes a Multi Get for a single id and a given {@see OsmPrimitiveType}.
-     * The retrieved primitive is merged to {@see #outputDataSet}.
+     * invokes a Multi Get for a single id and a given {@link OsmPrimitiveType}.
+     * The retrieved primitive is merged to {@link #outputDataSet}.
      *
      * @param type the type
@@ -333 +333 @@
 
     /**
-     * invokes a sequence of Multi Gets for individual ids in a set of ids and a given {@see OsmPrimitiveType}.
-     * The retrieved primitives are merged to {@see #outputDataSet}.
+     * invokes a sequence of Multi Gets for individual ids in a set of ids and a given {@link OsmPrimitiveType}.
+     * The retrieved primitives are merged to {@link #outputDataSet}.
      *
      * This method is used if one of the ids in pkg doesn't exist (the server replies with return code 404).
@@ -380 +380 @@
 
     /**
-     * merges the dataset <code>from</code> to {@see #outputDataSet}.
+     * merges the dataset <code>from</code> to {@link #outputDataSet}.
      *
      * @param from the other dataset
@@ -391 +391 @@
 
     /**
-     * fetches a set of ids of a given {@see OsmPrimitiveType} from the server
+     * fetches a set of ids of a given {@link OsmPrimitiveType} from the server
      *
      * @param ids the set of ids
@@ -423 +423 @@
 
     /**
-     * invokes one or more Multi Gets to fetch the {@see OsmPrimitive}s and replies
+     * invokes one or more Multi Gets to fetch the {@link OsmPrimitive}s and replies
      * the dataset of retrieved primitives. Note that the dataset includes non visible primitives too!
      * In contrast to a simple Get for a node, a way, or a relation, a Multi Get always replies
@@ -429 +429 @@
      * visible==false).
      *
-     * Invoke {@see #getMissingPrimitives()} to get a list of primitives which have not been
+     * Invoke {@link #getMissingPrimitives()} to get a list of primitives which have not been
      * found on  the server (the server response code was 404)
      *

trunk/src/org/openstreetmap/josm/io/OsmApi.java

@@ -59 +59 @@
 
     /**
-     * replies the {@see OsmApi} for a given server URL
+     * replies the {@link OsmApi} for a given server URL
      *
      * @param serverUrl  the server URL
@@ -75 +75 @@
     }
     /**
-     * replies the {@see OsmApi} for the URL given by the preference <code>osm-server.url</code>
+     * replies the {@link OsmApi} for the URL given by the preference <code>osm-server.url</code>
      *
      * @return the OsmApi
@@ -387 +387 @@
      *
      * @param changeset the changeset to update. Must not be null.
-     * @param monitor the progress monitor. If null, uses the {@see NullProgressMonitor#INSTANCE}.
+     * @param monitor the progress monitor. If null, uses the {@link NullProgressMonitor#INSTANCE}.
      *
      * @throws OsmTransferException if something goes wrong.
@@ -428 +428 @@
      *
      * @param changeset the changeset to be closed. Must not be null. changeset.getId() > 0 required.
-     * @param monitor the progress monitor. If null, uses {@see NullProgressMonitor#INSTANCE}
+     * @param monitor the progress monitor. If null, uses {@link NullProgressMonitor#INSTANCE}
      *
      * @throws OsmTransferException if something goes wrong.

trunk/src/org/openstreetmap/josm/io/OsmChangeReader.java

@@ -100 +100 @@
      *
      * @param source the source input stream. Must not be null.
-     * @param progressMonitor  the progress monitor. If null, {@see NullProgressMonitor#INSTANCE} is assumed
+     * @param progressMonitor  the progress monitor. If null, {@link NullProgressMonitor#INSTANCE} is assumed
      *
      * @return the dataset with the parsed data

trunk/src/org/openstreetmap/josm/io/OsmChangesetContentParser.java

@@ -300 +300 @@
      * Parses the content
      *
-     * @param progressMonitor the progress monitor. Set to {@see NullProgressMonitor#INSTANCE}
+     * @param progressMonitor the progress monitor. Set to {@link NullProgressMonitor#INSTANCE}
      * if null
      * @return the parsed data

trunk/src/org/openstreetmap/josm/io/OsmHistoryReader.java

@@ -32 +32 @@
  * Parser for OSM history data.
  *
- * It is slightly different from {@see OsmReader} because we don't build an internal graph of
- * {@see OsmPrimitive}s. We use objects derived from {@see HistoryOsmPrimitive} instead and we
- * keep the data in a dedicated {@see HistoryDataSet}.
+ * It is slightly different from {@link OsmReader} because we don't build an internal graph of
+ * {@link OsmPrimitive}s. We use objects derived from {@link HistoryOsmPrimitive} instead and we
+ * keep the data in a dedicated {@link HistoryDataSet}.
  *
  */

trunk/src/org/openstreetmap/josm/io/OsmReader.java

@@ -606 +606 @@
      *
      * @param source the source input stream. Must not be null.
-     * @param progressMonitor  the progress monitor. If null, {@see NullProgressMonitor#INSTANCE} is assumed
+     * @param progressMonitor  the progress monitor. If null, {@link NullProgressMonitor#INSTANCE} is assumed
      *
      * @return the dataset with the parsed data

trunk/src/org/openstreetmap/josm/io/OsmServerBackreferenceReader.java

@@ -21 +21 @@
 /**
  * OsmServerBackreferenceReader fetches the primitives from the OSM server which
- * refer to a specific primitive. For a {@see Node}, ways and relations are retrieved
- * which refer to the node. For a {@see Way} or a {@see Relation}, only relations are
+ * refer to a specific primitive. For a {@link Node}, ways and relations are retrieved
+ * which refer to the node. For a {@link Way} or a {@link Relation}, only relations are
  * read.
  *
@@ -29 +29 @@
  * of these calls is to reply incomplete primitives only.
  *
- * If you set {@see #setReadFull(boolean)} to true this reader uses a {@see MultiFetchServerObjectReader}
+ * If you set {@link #setReadFull(boolean)} to true this reader uses a {@link MultiFetchServerObjectReader}
  * to complete incomplete primitives.
  *
@@ -123 +123 @@
 
     /**
-     * Reads referring ways from the API server and replies them in a {@see DataSet}
+     * Reads referring ways from the API server and replies them in a {@link DataSet}
      *
      * @return the data set
@@ -160 +160 @@
 
     /**
-     * Reads referring relations from the API server and replies them in a {@see DataSet}
+     * Reads referring relations from the API server and replies them in a {@link DataSet}
      *
      * @param progressMonitor the progress monitor
@@ -203 +203 @@
      *
      * <ul>
-     *   <li>if this reader reads referers for a {@see Node}, referring ways are always
+     *   <li>if this reader reads referers for a {@link Node}, referring ways are always
      *     read individually from the server</li>
-     *   <li>if this reader reads referers for an {@see Way} or a {@see Relation}, referring relations
-     *    are only read fully if {@see #setReadFull(boolean)} is set to true.</li>
+     *   <li>if this reader reads referers for an {@link Way} or a {@link Relation}, referring relations
+     *    are only read fully if {@link #setReadFull(boolean)} is set to true.</li>
      * </ul>
      *
@@ -249 +249 @@
     /**
      * Reads the referring primitives from the OSM server, parses them and
-     * replies them as {@see DataSet}
-     *
-     * @param progressMonitor the progress monitor. Set to {@see NullProgressMonitor#INSTANCE} if null.
+     * replies them as {@link DataSet}
+     *
+     * @param progressMonitor the progress monitor. Set to {@link NullProgressMonitor#INSTANCE} if null.
      * @return the dataset with the referring primitives
      * @exception OsmTransferException thrown if an error occurs while communicating with the server

trunk/src/org/openstreetmap/josm/io/OsmServerChangesetReader.java

@@ -22 +22 @@
 
 /**
- * Reads the history of an {@see OsmPrimitive} from the OSM API server.
+ * Reads the history of an {@link OsmPrimitive} from the OSM API server.
  *
  */
@@ -47 +47 @@
      * Queries a list
      * @param query  the query specification. Must not be null.
-     * @param monitor a progress monitor. Set to {@see NullProgressMonitor#INSTANCE} if null
+     * @param monitor a progress monitor. Set to {@link NullProgressMonitor#INSTANCE} if null
      * @return the list of changesets read from the server
      * @throws IllegalArgumentException thrown if query is null
@@ -80 +80 @@
      *
      * @param id  the changeset id. id > 0 required.
-     * @param monitor the progress monitor. Set to {@see NullProgressMonitor#INSTANCE} if null
+     * @param monitor the progress monitor. Set to {@link NullProgressMonitor#INSTANCE} if null
      * @return the changeset read
      * @throws OsmTransferException thrown if something goes wrong
@@ -116 +116 @@
      *
      * @param ids  the list of ids. Ignored if null. Only load changesets for ids > 0.
-     * @param monitor the progress monitor. Set to {@see NullProgressMonitor#INSTANCE} if null
+     * @param monitor the progress monitor. Set to {@link NullProgressMonitor#INSTANCE} if null
      * @return the changeset read
      * @throws OsmTransferException thrown if something goes wrong
@@ -165 +165 @@
      *
      * @param id the changeset id. >0 required.
-     * @param monitor the progress monitor. {@see NullProgressMonitor#INSTANCE} assumed if null.
+     * @param monitor the progress monitor. {@link NullProgressMonitor#INSTANCE} assumed if null.
      * @return the changeset content
      * @throws IllegalArgumentException thrown if id <= 0

trunk/src/org/openstreetmap/josm/io/OsmServerHistoryReader.java

@@ -14 +14 @@
 
 /**
- * Reads the history of an {@see OsmPrimitive} from the OSM API server.
+ * Reads the history of an {@link OsmPrimitive} from the OSM API server.
  *
  */

trunk/src/org/openstreetmap/josm/io/OsmServerObjectReader.java

@@ -106 +106 @@
      * Downloads and parses the data.
      *
-     * @param progressMonitor the progress monitor. Set to {@see NullProgressMonitor#INSTANCE} if
+     * @param progressMonitor the progress monitor. Set to {@link NullProgressMonitor#INSTANCE} if
      * null
      * @return the downloaded data

trunk/src/org/openstreetmap/josm/io/OsmServerWriter.java

@@ -185 +185 @@
      * @param primitives list of objects to send
      * @param changeset the changeset the data is uploaded to. Must not be null.
-     * @param monitor the progress monitor. If null, assumes {@see NullProgressMonitor#INSTANCE}
+     * @param monitor the progress monitor. If null, assumes {@link NullProgressMonitor#INSTANCE}
      * @throws IllegalArgumentException thrown if changeset is null
      * @throws IllegalArgumentException thrown if strategy is null

trunk/src/org/openstreetmap/josm/io/auth/CredentialsAgent.java

@@ -11 +11 @@
  * A CredentialsAgent manages two credentials:
  * <ul>
- *   <li>the credential for {@see RequestorType#SERVER} which is equal to the OSM API credentials
+ *   <li>the credential for {@link RequestorType#SERVER} which is equal to the OSM API credentials
  *   in JOSM</li>
- *   <li>the credential for {@see RequestorType#PROXY} which is equal to the credentials for an
+ *   <li>the credential for {@link RequestorType#PROXY} which is equal to the credentials for an
  *   optional HTTP proxy server a user may use</li>
  *  </ul>
@@ -24 +24 @@
      * Looks up the credentials for a given type.
      *
-     * @param the type of service. {@see RequestorType#SERVER} for the OSM API server, {@see RequestorType#PROXY}
+     * @param the type of service. {@link RequestorType#SERVER} for the OSM API server, {@link RequestorType#PROXY}
      * for a proxy server
      * @return the credentials
@@ -34 +34 @@
      * Saves the credentials in <code>credentials</code> for the given service type.
      *
-     * @param the type of service. {@see RequestorType#SERVER} for the OSM API server, {@see RequestorType#PROXY}
+     * @param the type of service. {@link RequestorType#SERVER} for the OSM API server, {@link RequestorType#PROXY}
      * for a proxy server
      * @param credentials the credentials
@@ -43 +43 @@
     /**
      *
-     * @param requestorType  the type of service. {@see RequestorType#SERVER} for the OSM API server, {@see RequestorType#PROXY}
+     * @param requestorType  the type of service. {@link RequestorType#SERVER} for the OSM API server, {@link RequestorType#PROXY}
      * for a proxy server
      * @param noSuccessWithLastResponse true, if the last request with the supplied credentials failed; false otherwise.

trunk/src/org/openstreetmap/josm/io/auth/CredentialsAgentResponse.java

@@ -3 +3 @@
 
 /**
- * CredentialsAgentResponse represents the response from {@see CredentialsAgent#getCredentials(java.net.Authenticator.RequestorType, boolean)}.
+ * CredentialsAgentResponse represents the response from {@link CredentialsAgent#getCredentials(java.net.Authenticator.RequestorType, boolean)}.
  *
  * The response consists of the username and the password the requested credentials consists of.
  * In addition, it provides information whether authentication was canceled by the user, i.e.
- * because he or she canceled a username/password dialog (see {@see #isCanceled()}.
+ * because he or she canceled a username/password dialog (see {@link #isCanceled()}.
  *
  */

trunk/src/org/openstreetmap/josm/io/auth/CredentialsManager.java

@@ -14 +14 @@
  * CredentialManager is a factory for the single credential agent used.
  *
- * Currently, it defaults to replying an instance of {@see JosmPreferencesCredentialAgent}.
+ * Currently, it defaults to replying an instance of {@link JosmPreferencesCredentialAgent}.
  *
  */

trunk/src/org/openstreetmap/josm/io/auth/DefaultAuthenticator.java

@@ -12 +12 @@
  * This is the default authenticator used in JOSM. It delegates lookup of credentials
  * for the OSM API and an optional proxy server to the currently configured
- * {@see CredentialsManager}.
+ * {@link CredentialsManager}.
  *
  */