Ignore:
Timestamp:
2012-06-03T16:41:25+02:00 (14 years ago)
Author:
bastiK
Message:

fixed majority of javadoc warnings by replacing "{@see" by "{@link"

File:
1 edited

Legend:

Unmodified
Added
Removed

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

    r4217 r5266  
    2929
    3030/**
    31  * Retrieves a set of {@see OsmPrimitive}s from an OSM server using the so called
     31 * Retrieves a set of {@link OsmPrimitive}s from an OSM server using the so called
    3232 * Multi Fetch API.
    3333 *
    … …  
    7777
    7878    /**
    79      * Remembers an {@see OsmPrimitive}'s id. The id will
     79     * Remembers an {@link OsmPrimitive}'s id. The id will
    8080     * later be fetched as part of a Multi Get request.
    8181     *
    … …  
    9494
    9595    /**
    96      * remembers an {@see OsmPrimitive}'s id. <code>ds</code> must include
    97      * an {@see OsmPrimitive} with id=<code>id</code>. The id will
     96     * remembers an {@link OsmPrimitive}'s id. <code>ds</code> must include
     97     * an {@link OsmPrimitive} with id=<code>id</code>. The id will
    9898     * later we fetched as part of a Multi Get request.
    9999     *
    … …  
    103103     * @param id  the id
    104104     * @exception IllegalArgumentException thrown, if ds is null
    105      * @exception NoSuchElementException thrown, if ds doesn't include an {@see OsmPrimitive} with
     105     * @exception NoSuchElementException thrown, if ds doesn't include an {@link OsmPrimitive} with
    106106     *   id=<code>id</code>
    107107     */
    … …  
    135135
    136136    /**
    137      * appends a {@see Node}s id to the list of ids which will be fetched from the server.
     137     * appends a {@link Node}s id to the list of ids which will be fetched from the server.
    138138     *
    139139     * @param node  the node (ignored, if null)
    … …  
    148148
    149149    /**
    150      * 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.
     150     * 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.
    151151     *
    152152     * @param way the way (ignored, if null)
    … …  
    167167
    168168    /**
    169      * appends a {@see Relation}s id to the list of ids which will be fetched from the server.
     169     * appends a {@link Relation}s id to the list of ids which will be fetched from the server.
    170170     *
    171171     * @param relation  the relation (ignored, if null)
    … …  
    204204
    205205    /**
    206      * appends a list of {@see OsmPrimitive} to the list of ids which will be fetched from the server.
     206     * appends a list of {@link OsmPrimitive} to the list of ids which will be fetched from the server.
    207207     *
    208208     * @param primitives  the list of primitives (ignored, if null)
    … …  
    223223
    224224    /**
    225      * extracts a subset of max {@see #MAX_IDS_PER_REQUEST} ids from <code>ids</code> and
     225     * extracts a subset of max {@link #MAX_IDS_PER_REQUEST} ids from <code>ids</code> and
    226226     * replies the subset. The extracted subset is removed from <code>ids</code>.
    227227     *
    … …  
    248248    /**
    249249     * builds the Multi Get request string for a set of ids and a given
    250      * {@see OsmPrimitiveType}.
     250     * {@link OsmPrimitiveType}.
    251251     *
    252252     * @param type the type
    … …  
    271271    /**
    272272     * builds the Multi Get request string for a single id and a given
    273      * {@see OsmPrimitiveType}.
     273     * {@link OsmPrimitiveType}.
    274274     *
    275275     * @param type the type
    … …  
    286286
    287287    /**
    288      * invokes a Multi Get for a set of ids and a given {@see OsmPrimitiveType}.
    289      * The retrieved primitives are merged to {@see #outputDataSet}.
     288     * invokes a Multi Get for a set of ids and a given {@link OsmPrimitiveType}.
     289     * The retrieved primitives are merged to {@link #outputDataSet}.
    290290     *
    291291     * @param type the type
    … …  
    309309
    310310    /**
    311      * invokes a Multi Get for a single id and a given {@see OsmPrimitiveType}.
    312      * The retrieved primitive is merged to {@see #outputDataSet}.
     311     * invokes a Multi Get for a single id and a given {@link OsmPrimitiveType}.
     312     * The retrieved primitive is merged to {@link #outputDataSet}.
    313313     *
    314314     * @param type the type
    … …  
    333333
    334334    /**
    335      * invokes a sequence of Multi Gets for individual ids in a set of ids and a given {@see OsmPrimitiveType}.
    336      * The retrieved primitives are merged to {@see #outputDataSet}.
     335     * invokes a sequence of Multi Gets for individual ids in a set of ids and a given {@link OsmPrimitiveType}.
     336     * The retrieved primitives are merged to {@link #outputDataSet}.
    337337     *
    338338     * This method is used if one of the ids in pkg doesn't exist (the server replies with return code 404).
    … …  
    380380
    381381    /**
    382      * merges the dataset <code>from</code> to {@see #outputDataSet}.
     382     * merges the dataset <code>from</code> to {@link #outputDataSet}.
    383383     *
    384384     * @param from the other dataset
    … …  
    391391
    392392    /**
    393      * fetches a set of ids of a given {@see OsmPrimitiveType} from the server
     393     * fetches a set of ids of a given {@link OsmPrimitiveType} from the server
    394394     *
    395395     * @param ids the set of ids
    … …  
    423423
    424424    /**
    425      * invokes one or more Multi Gets to fetch the {@see OsmPrimitive}s and replies
     425     * invokes one or more Multi Gets to fetch the {@link OsmPrimitive}s and replies
    426426     * the dataset of retrieved primitives. Note that the dataset includes non visible primitives too!
    427427     * In contrast to a simple Get for a node, a way, or a relation, a Multi Get always replies
    … …  
    429429     * visible==false).
    430430     *
    431      * Invoke {@see #getMissingPrimitives()} to get a list of primitives which have not been
     431     * Invoke {@link #getMissingPrimitives()} to get a list of primitives which have not been
    432432     * found on  the server (the server response code was 404)
    433433     *
Note: See TracChangeset for help on using the changeset viewer.