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

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

Files:

• CredentialsAgent.java (modified) (4 diffs)
• CredentialsAgentResponse.java (modified) (1 diff)
• CredentialsManager.java (modified) (1 diff)
• DefaultAuthenticator.java (modified) (1 diff)

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}.
  *
  */