Changeset 5836 in josm for trunk


Ignore:
Timestamp:
2013-04-07T23:18:22+02:00 (7 years ago)
Author:
stoecker
Message:

javadoc fixes

Location:
trunk/src/org/openstreetmap/josm
Files:
7 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/org/openstreetmap/josm/gui/io/SaveLayerInfo.java

    r5266 r5836  
    6565     * Replies true if this layer should be uploaded to the server; false, otherwise
    6666     *
    67      * @return true if this layer should be uploaded to the server; false, otherwise
     67     * @return {@code true} if this layer should be uploaded to the server; {@code false}, otherwise
    6868     */
    6969    public boolean isDoUploadToServer() {
     
    7474     * Sets whether this layer should be uploaded to a file
    7575     *
    76      * @param doSaveToFile true to upload; false, to skip uploading
     76     * @param doUploadToServer {@code true} to upload; {@code false}, to skip uploading
    7777     */
    7878
     
    142142     * Replies the upload state of {@link #getLayer()}.
    143143     * <ul>
    144      *   <li>{@link UploadOrSaveState#OK} if {@link #getLayer() was successfully uploaded</li>
    145      *   <li>{@link UploadOrSaveState#canceled} if uploading {@link #getLayer() was canceled</li>
    146      *   <li>{@link UploadOrSaveState#FAILED} if uploading {@link #getLayer() has failed</li>
     144     *   <li>{@link UploadOrSaveState#OK} if {@link #getLayer()} was successfully uploaded</li>
     145     *   <li>{@link UploadOrSaveState#CANCELED} if uploading {@link #getLayer()} was canceled</li>
     146     *   <li>{@link UploadOrSaveState#FAILED} if uploading {@link #getLayer()} has failed</li>
    147147     * </ul>
    148148     *
     
    165165     * Replies the save state of {@link #getLayer()}.
    166166     * <ul>
    167      *   <li>{@link UploadOrSaveState#OK} if {@link #getLayer() was successfully saved to file</li>
    168      *   <li>{@link UploadOrSaveState#canceled} if saving {@link #getLayer() was canceled</li>
    169      *   <li>{@link UploadOrSaveState#FAILED} if saving {@link #getLayer() has failed</li>
     167     *   <li>{@link UploadOrSaveState#OK} if {@link #getLayer()} was successfully saved to file</li>
     168     *   <li>{@link UploadOrSaveState#CANCELED} if saving {@link #getLayer()} was canceled</li>
     169     *   <li>{@link UploadOrSaveState#FAILED} if saving {@link #getLayer()} has failed</li>
    170170     * </ul>
    171171     *
  • trunk/src/org/openstreetmap/josm/io/auth/CredentialsAgent.java

    r5266 r5836  
    2424     * Looks up the credentials for a given type.
    2525     *
    26      * @param the type of service. {@link RequestorType#SERVER} for the OSM API server, {@link RequestorType#PROXY}
     26     * @param requestorType the type of service. {@link RequestorType#SERVER} for the OSM API server, {@link RequestorType#PROXY}
    2727     * for a proxy server
     28     * @param host the hostname for these credentials
    2829     * @return the credentials
    2930     * @throws CredentialsAgentException thrown if a problem occurs in a implementation of this interface
     
    3435     * Saves the credentials in <code>credentials</code> for the given service type.
    3536     *
    36      * @param the type of service. {@link RequestorType#SERVER} for the OSM API server, {@link RequestorType#PROXY}
     37     * @param requestorType the type of service. {@link RequestorType#SERVER} for the OSM API server, {@link RequestorType#PROXY}
    3738     * for a proxy server
     39     * @param host the hostname for these credentials
    3840     * @param credentials the credentials
    3941     * @throws CredentialsManagerException thrown if a problem occurs in a implementation of this interface
     
    4345    /**
    4446     *
    45      * @param requestorType  the type of service. {@link RequestorType#SERVER} for the OSM API server, {@link RequestorType#PROXY}
     47     * @param requestorType the type of service. {@link RequestorType#SERVER} for the OSM API server, {@link RequestorType#PROXY}
    4648     * for a proxy server
     49     * @param host the hostname for these credentials
    4750     * @param noSuccessWithLastResponse true, if the last request with the supplied credentials failed; false otherwise.
    4851     * If true, implementations of this interface are advised to prompt the user for new credentials.
  • trunk/src/org/openstreetmap/josm/plugins/Plugin.java

    r5241 r5836  
    6969     * Sets the plugin information object for this plugin
    7070     *
    71      * @parma info the plugin information object
     71     * @param info the plugin information object
    7272     */
    7373    public void setPluginInformation(PluginInformation info) {
  • trunk/src/org/openstreetmap/josm/plugins/PluginDownloadTask.java

    r5587 r5836  
    4545     * Creates the download task
    4646     *
    47      * @param parent the parent component relative to which the {@link PleaseWaitDialog} is displayed
     47     * @param parent the parent component relative to which the {@link org.openstreetmap.josm.gui.PleaseWaitDialog} is displayed
    4848     * @param toUpdate a collection of plugin descriptions for plugins to update/download. Must not be null.
    49      * @param title the title to display in the {@link PleaseWaitDialog}
     49     * @param title the title to display in the {@link org.openstreetmap.josm.gui.PleaseWaitDialog}
    5050     * @throws IllegalArgumentException thrown if toUpdate is null
    5151     */
     
    6161     * @param monitor a progress monitor. Defaults to {@link NullProgressMonitor#INSTANCE} if null
    6262     * @param toUpdate a collection of plugin descriptions for plugins to update/download. Must not be null.
    63      * @param title the title to display in the {@link PleaseWaitDialog}
     63     * @param title the title to display in the {@link org.openstreetmap.josm.gui.PleaseWaitDialog}
    6464     * @throws IllegalArgumentException thrown if toUpdate is null
    6565     */
     
    178178     * Replies true if the task was canceled by the user
    179179     *
    180      * @return
     180     * @return <code>true</code> if the task was stopped by the user
    181181     */
    182182    public boolean isCanceled() {
  • trunk/src/org/openstreetmap/josm/plugins/PluginInformation.java

    r5723 r5836  
    294294     * Load and instantiate the plugin
    295295     *
    296      * @param the plugin class
     296     * @param klass the plugin class
    297297     * @return the instantiated and initialized plugin
    298298     */
  • trunk/src/org/openstreetmap/josm/plugins/ReadLocalPluginInformationTask.java

    r5723 r5836  
    2525 * in the local plugin repositories.
    2626 *
    27  * It scans the files in the local plugins repository (see {@link Preferences#getPluginsDirectory()}
     27 * It scans the files in the local plugins repository (see {@link org.openstreetmap.josm.data.Preferences#getPluginsDirectory()}
    2828 * and extracts plugin information from three kind of files:
    2929 * <ul>
  • trunk/src/org/openstreetmap/josm/plugins/ReadRemotePluginInformationTask.java

    r5601 r5836  
    372372    /**
    373373     * Replies true if the task was canceled
    374      * @return
     374     * @return <code>true</code> if the task was stopped by the user
    375375     */
    376376    public boolean isCanceled() {
Note: See TracChangeset for help on using the changeset viewer.