Changeset 8929 in josm for trunk/src/org


Ignore:
Timestamp:
2015-10-22T16:20:56+02:00 (4 years ago)
Author:
Don-vip
Message:

javadoc fixes

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

Legend:

Unmodified
Added
Removed
  • trunk/src/org/openstreetmap/josm/actions/DownloadAlongAction.java

    r8926 r8929  
    1010import java.util.Collection;
    1111import java.util.List;
    12 import java.util.concurrent.CancellationException;
    13 import java.util.concurrent.ExecutionException;
    1412import java.util.concurrent.Future;
    1513
  • trunk/src/org/openstreetmap/josm/gui/progress/ProgressMonitor.java

    r8512 r8929  
    134134     * @param ticks Number of work units that should be done when subtask finishes
    135135     * @param internal If true then subtask can't modify task title/custom text
     136     * @return subtasks monitor
    136137     */
    137138    ProgressMonitor createSubTaskMonitor(int ticks, boolean internal);
  • trunk/src/org/openstreetmap/josm/gui/util/GuiHelper.java

    r8905 r8929  
    316316    /**
    317317     * Gets the font used to display JOSM title in about dialog and splash screen.
     318     * @return title font
    318319     * @since 5797
    319320     */
  • trunk/src/org/openstreetmap/josm/gui/util/HighlightHelper.java

    r8510 r8929  
    2323     * Highlight and remember given primitives
    2424     * @param prims - primitives to highlight/unhighlight
     25     * @return {@code true} if a repaint is needed
    2526     */
    2627    public boolean highlight(Collection<? extends OsmPrimitive> prims) {
     
    3233     * @param prims - primitives to highlight/unhighlight
    3334     * @param only - remove previous highlighting
     35     * @return {@code true} if a repaint is needed
    3436     */
    3537    public boolean highlight(Collection<? extends OsmPrimitive> prims, boolean only) {
     
    5658     * Highlight and remember given primitives, forgetting previously highlighted by this instance
    5759     * @param prims - primitives to highlight/unhighlight
     60     * @return {@code true} if a repaint is needed
    5861     */
    5962    public boolean highlightOnly(Collection<? extends OsmPrimitive> prims) {
     
    6467     * Highlight and remember given primitive, forgetting previously highlighted by this instance
    6568     * @param p - primitives to highlight/unhighlight
     69     * @return {@code true} if a repaint is needed
    6670     */
    6771    public boolean highlightOnly(OsmPrimitive p) {
     
    7377     * @param p - primitive to highlight/unhighlight
    7478     * @param flag - true to highlight
     79     * @return {@code true} if a repaint is needed
    7580     */
    7681    public boolean setHighlight(OsmPrimitive p, boolean flag) {
  • trunk/src/org/openstreetmap/josm/gui/util/RotationAngle.java

    r8624 r8929  
    1515 */
    1616public abstract class RotationAngle {
     17
    1718    /**
    1819     * Calculates the rotation angle depending on the primitive to displayed.
     20     * @param p primitive
     21     * @return rotation angle
    1922     */
    2023    public abstract double getRotationAngle(OsmPrimitive p);
     
    2225    /**
    2326     * Always returns the fixed {@code angle}.
     27     * @param angle angle
     28     * @return rotation angle
    2429     */
    2530    public static RotationAngle buildStaticRotation(final double angle) {
     
    3944    /**
    4045     * Parses the rotation angle from the specified {@code string}.
     46     * @param string angle as string
     47     * @return rotation angle
    4148     */
    4249    public static RotationAngle buildStaticRotation(final String string) {
     
    8996    /**
    9097     * Computes the angle depending on the referencing way segment, or {@code 0} if none exists.
     98     * @return rotation angle
    9199     */
    92100    public static RotationAngle buildWayDirectionRotation() {
  • trunk/src/org/openstreetmap/josm/gui/widgets/DisableShortcutsOnFocusGainedTextField.java

    r8510 r8929  
    158158    /**
    159159     * Returns true if the given shortcut has no modifier and is not an actions key.
     160     * @param ks key stroke
     161     * @return {@code true} if the given shortcut has to be disabled
    160162     * @see KeyEvent#isActionKey()
    161163     */
  • trunk/src/org/openstreetmap/josm/gui/widgets/QuadStateCheckBox.java

    r8513 r8929  
    158158         * selected and armed (grey) and NOT_SELECTED when the
    159159         * checkbox is deselected.
     160         * @return current state
    160161         */
    161162        private State getState() {
  • trunk/src/org/openstreetmap/josm/io/BoundingBoxDownloader.java

    r8926 r8929  
    114114    /**
    115115     * Returns the name of the download task to be displayed in the {@link ProgressMonitor}.
     116     * @return task name
    116117     */
    117118    protected String getTaskName() {
     
    121122    /**
    122123     * Builds the request part for the bounding box.
     124     * @param lon1 left
     125     * @param lat1 bottom
     126     * @param lon2 right
     127     * @param lat2 top
     128     * @return "map?bbox=left,bottom,right,top"
    123129     */
    124130    protected String getRequestForBbox(double lon1, double lat1, double lon2, double lat2) {
     
    128134    /**
    129135     * Parse the given input source and return the dataset.
     136     * @param source input stream
     137     * @param progressMonitor progress monitor
     138     * @return dataset
    130139     * @throws IllegalDataException if an error was found while parsing the OSM data
    131140     *
  • trunk/src/org/openstreetmap/josm/io/CachedFile.java

    r8846 r8929  
    351351     * 2 resources that point to the same url, but that are to be stored in different
    352352     * directories will not share a cache file.
     353     * @param url URL
     354     * @param destDir destination directory
     355     * @return Preference key
    353356     */
    354357    private static String getPrefKey(URL url, String destDir) {
  • trunk/src/org/openstreetmap/josm/io/Compression.java

    r8470 r8929  
    5454    /**
    5555     * Returns an un-compressing {@link InputStream} for {@code in}.
     56     * @param in raw input stream
     57     * @return un-compressing input stream
    5658     *
    5759     * @throws IOException if any I/O error occurs
     
    7375    /**
    7476     * Returns an un-compressing {@link InputStream} for the {@link File} {@code file}.
    75      *
     77     * @param file file
     78     * @return un-compressing input stream
    7679     * @throws IOException if any I/O error occurs
    7780     */
     
    8386    /**
    8487     * Returns an un-compressing {@link InputStream} for the {@link URL} {@code url}.
     88     * @param url URL
     89     * @return un-compressing input stream
    8590     *
    8691     * @throws IOException if any I/O error occurs
     
    9297    /**
    9398     * Returns a compressing {@link OutputStream} for {@code out}.
     99     * @param out raw output stream
     100     * @return compressing output stream
    94101     *
    95102     * @throws IOException if any I/O error occurs
     
    111118    /**
    112119     * Returns a compressing {@link OutputStream} for the {@link File} {@code file}.
     120     * @param file file
     121     * @return compressing output stream
    113122     *
    114123     * @throws IOException if any I/O error occurs
  • trunk/src/org/openstreetmap/josm/io/FileImporter.java

    r7596 r8929  
    142142     * they are opened in the order of their priorities.
    143143     * Highest priority comes first.
     144     * @return priority
    144145     */
    145146    public double getPriority() {
  • trunk/src/org/openstreetmap/josm/io/OsmImporter.java

    r8926 r8929  
    113113     * @param layerName name of generated layer
    114114     * @param progressMonitor handler for progress monitoring and canceling
     115     * @return Utility class containing imported OSM layer, and a task to run after it is added to MapView
    115116     * @throws IllegalDataException if an error was found while parsing the OSM data
    116117     */
  • trunk/src/org/openstreetmap/josm/io/XmlWriter.java

    r8510 r8929  
    4343     *     new JLabel("&lt;html&gt;&amp;apos;&lt;/html&gt;")
    4444     * literally as 6 character string, see #7558)
     45     * @return XML1.0 string
    4546     */
    4647    public static String encode(String unencoded, boolean keepApos) {
  • trunk/src/org/openstreetmap/josm/io/auth/AbstractCredentialsAgent.java

    r8388 r8929  
    9696     * Provide the text for a checkbox that offers to save the
    9797     * username and password that has been entered by the user.
     98     * @return checkbox text
    9899     */
    99100    public abstract String getSaveUsernameAndPasswordCheckboxText();
  • trunk/src/org/openstreetmap/josm/io/auth/CredentialsAgent.java

    r8509 r8929  
    4444
    4545    /**
    46      *
     46     * Returns the credentials needed to to access host.
    4747     * @param requestorType the type of service. {@link RequestorType#SERVER} for the OSM API server, {@link RequestorType#PROXY}
    4848     * for a proxy server
     
    5050     * @param noSuccessWithLastResponse true, if the last request with the supplied credentials failed; false otherwise.
    5151     * If true, implementations of this interface are advised to prompt the user for new credentials.
     52     * @return the credentials
    5253     * @throws CredentialsAgentException if a problem occurs in a implementation of this interface
    53 
    5454     */
    5555    CredentialsAgentResponse getCredentials(RequestorType requestorType, String host, boolean noSuccessWithLastResponse)
     
    7373    void storeOAuthAccessToken(OAuthToken accessToken) throws CredentialsAgentException;
    7474
    75 
    7675    /**
    7776     * Provide a Panel that is shown below the API password / username fields
    7877     * in the JOSM Preferences. (E.g. a warning that password is saved unencrypted.)
     78     * @return Panel
    7979     */
    8080    Component getPreferencesDecorationPanel();
    81 
    8281}
  • trunk/src/org/openstreetmap/josm/io/remotecontrol/handler/AddWayHandler.java

    r8846 r8929  
    120120
    121121    /**
    122      * Find the node with almost the same ccords in dataset or in already added nodes
     122     * Find the node with almost the same coords in dataset or in already added nodes
     123     * @param ll coordinates
     124     * @return node with almost the same coords
    123125     * @since 5845
    124126     */
  • trunk/src/org/openstreetmap/josm/io/remotecontrol/handler/RequestHandler.java

    r8846 r8929  
    200200
    201201    /**
     202     * Returns the request parameters.
     203     * @param uri URI as string
     204     * @return map of request parameters
    202205     * @see <a href="http://blog.lunatech.com/2009/02/03/what-every-web-developer-must-know-about-url-encoding">
    203206     *      What every web developer must know about URL encoding</a>
  • trunk/src/org/openstreetmap/josm/io/session/SessionReader.java

    r8926 r8929  
    171171         *     - relativ to the .joz file:
    172172         *         "../save/data.osm"           ("../" steps out of the archive)
     173         * @param uriStr URI as string
     174         * @return the InputStream
    173175         *
    174176         * @throws IOException Thrown when no Stream can be opened for the given URI, e.g. when the linked file has been deleted.
     
    246248        /**
    247249         * Name of the layer that is currently imported.
     250         * @return layer name
    248251         */
    249252        public String getLayerName() {
     
    253256        /**
    254257         * Index of the layer that is currently imported.
     258         * @return layer index
    255259         */
    256260        public int getLayerIndex() {
     
    261265         * Dependencies - maps the layer index to the importer of the given
    262266         * layer. All the dependent importers have loaded completely at this point.
     267         * @return layer dependencies
    263268         */
    264269        public List<LayerDependency> getLayerDependencies() {
Note: See TracChangeset for help on using the changeset viewer.