Ignore:
Timestamp:
2013-04-18T19:03:55+02:00 (11 years ago)
Author:
stoecker
Message:

javadoc fixes

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

Legend:

Unmodified
Added
Removed

  • trunk/src/org/openstreetmap/josm/data/Version.java

    r5874 r5881  
    230230     * Returns the full User-Agent string
    231231     * @return The User-Agent
    232      * @since 5866
     232     * @since 5868
    233233     */
    234234    public String getFullAgentString() {

  • trunk/src/org/openstreetmap/josm/data/osm/DataSet.java

    r5798 r5881  
    135135     * This method can be used to detect changes in highlight state of primitives. If highlighting was changed
    136136     * then the method will return different number.
    137      * @return
     137     * @return the current highlight counter
    138138     */
    139139    public int getHighlightUpdateCount() {
    … …  
    149149     * Replies the history of JOSM selections
    150150     *
    151      * @return
     151     * @return list of history entries
    152152     */
    153153    public LinkedList<Collection<? extends OsmPrimitive>> getSelectionHistory() {
    … …  
    371371     * primitive are left unchanged.
    372372     *
    373      * @param primitive the primitive
     373     * @param primitiveId the id of the primitive
    374374     */
    375375    public void removePrimitive(PrimitiveId primitiveId) {
    … …  
    556556     * *WaySegments* to avoid a VirtualNode class that wouldn't have much use
    557557     * otherwise.
    558      * @param Collection of waySegments
     558     * @param waySegments Collection of way segments
    559559     */
    560560    public void setHighlightedVirtualNodes(Collection<WaySegment> waySegments) {
    … …  
    569569    /**
    570570     * set what virtual ways should be highlighted.
    571      * @param Collection of waySegments
     571     * @param waySegments Collection of way segments
    572572     */
    573573    public void setHighlightedWaySegments(Collection<WaySegment> waySegments) {
    … …  
    681681    /**
    682682     * Remove the selection from every value in the collection.
    683      * @param list The collection to remove the selection from.
     683     * @param osm The collection of ids to remove the selection from.
    684684     */
    685685    public void clearSelection(PrimitiveId... osm) {
    … …  
    950950    /**
    951951     * Can be called before bigger changes on dataset. Events are disabled until {@link #endUpdate()}.
    952      * {@link DataSetListener#dataChanged()} event is triggered after end of changes
     952     * {@link DataSetListener#dataChanged(DataChangedEvent event)} event is triggered after end of changes
    953953     * <br>
    954954     * Typical usecase should look like this:
    … …  
    10551055     *
    10561056     * This method can be invoked after the globally configured projection method
    1057      * changed. In contrast to {@link DataSet#reproject()} it only invalidates the
    1058      * cache and doesn't reproject the coordinates.
     1057     * changed.
    10591058     */
    10601059    public void invalidateEastNorthCache() {

  • trunk/src/org/openstreetmap/josm/data/osm/DataSetMerger.java

    r5350 r5881  
    4848     * constructor
    4949     *
    50      * The visitor will merge <code>theirDataSet</code> onto <code>myDataSet</code>
    51      *
    52      * @param targetDataSet  dataset with my primitives. Must not be null.
     50     * The visitor will merge <code>sourceDataSet</code> onto <code>targetDataSet</code>
     51     *
     52     * @param targetDataSet dataset with my primitives. Must not be null.
    5353     * @param sourceDataSet dataset with their primitives. Ignored, if null.
    5454     * @throws IllegalArgumentException thrown if myDataSet is null
    … …  
    6565
    6666    /**
    67      * Merges a primitive <code>other</code> of type <P> onto my primitives.
     67     * Merges a primitive onto primitives dataset.
    6868     *
    6969     * If other.id != 0 it tries to merge it with an corresponding primitive from
    … …  
    7171     * in {@link #conflicts}.
    7272     *
    73      * If other.id == 0 it tries to find a primitive in my dataset with id == 0 which
     73     * If other.id == 0 (new primitive) it tries to find a primitive in my dataset with id == 0 which
    7474     * is semantically equal. If it finds one it merges its technical attributes onto
    7575     * my primitive.
    7676     *
    77      * @param <P>  the type of the other primitive
    78      * @param source  the other primitive
     77     * @param source the primitive to merge
     78     * @param candidates a set of possible candidates for a new primitive
    7979     */
    8080    protected void mergePrimitive(OsmPrimitive source, Collection<? extends OsmPrimitive> candidates) {
    … …  
    385385    /**
    386386     * Runs the merge operation. Successfully merged {@link OsmPrimitive}s are in
    387      * {@link #getMyDataSet()}.
     387     * {@link #getTargetDataSet()}.
    388388     *
    389389     * See {@link #getConflicts()} for a map of conflicts after the merge operation.
    … …  
    395395    /**
    396396     * Runs the merge operation. Successfully merged {@link OsmPrimitive}s are in
    397      * {@link #getMyDataSet()}.
     397     * {@link #getTargetDataSet()}.
    398398     *
    399399     * See {@link #getConflicts()} for a map of conflicts after the merge operation.
    … …  
    443443     * replies my dataset
    444444     *
    445      * @return
     445     * @return the own (target) data set
    446446     */
    447447    public DataSet getTargetDataSet() {

  • trunk/src/org/openstreetmap/josm/data/osm/RelationMember.java

    r3844 r5881  
    114114     * @param role Can be null, in this case it's save as ""
    115115     * @param member Cannot be null
    116      * @throw IllegalArgumentException thrown if member is null
     116     * @throws IllegalArgumentException thrown if member is <code>null</code>
    117117     */
    118118    public RelationMember(String role, OsmPrimitive member) throws IllegalArgumentException{

  • trunk/src/org/openstreetmap/josm/data/osm/event/DataSetListener.java

    r5170 r5881  
    3232     * deleted/invisible primitives were resurrected.
    3333     *
    34      * @param added A collection of newly-visible primitives
     34     * @param event An event for an collection of newly-visible primitives
    3535     */
    3636    void primitivesAdded(PrimitivesAddedEvent event);
    … …  
    4040     * primitives were marked as deleted.
    4141     *
    42      * @param removed A collection of newly-invisible primitives
     42     * @param event An event for an collection of newly-invisible primitives
    4343     */
    4444    void primitivesRemoved(PrimitivesRemovedEvent event);
    … …  
    4848     * a tag addition, tag removal or change in tag value.
    4949     *
    50      * @param prim the primitive, whose tags were affected.
     50     * @param event the event for the primitive, whose tags were affected.
    5151     */
    5252    void tagsChanged(TagsChangedEvent event);
    … …  
    5454    /**
    5555     * A node's coordinates were modified.
    56      * @param node The node that was moved.
     56     * @param event The event for the node that was moved.
    5757     */
    5858    void nodeMoved(NodeMovedEvent event);
    … …  
    6060    /**
    6161     * A way's node list was changed.
    62      * @param way The way that was modified.
     62     * @param event The event for the way that was modified.
    6363     */
    6464    void wayNodesChanged(WayNodesChangedEvent event);
    … …  
    6666    /**
    6767     * A relation's members have changed.
    68      * @param relation The relation that was modified.
     68     * @param event The event for the relation that was modified.
    6969     */
    7070    void relationMembersChanged(RelationMembersChangedEvent event);
    … …  
    7373     * Minor dataset change, currently only changeset id changed is supported, but can
    7474     * be extended in future.
    75      * @param event
     75     * @param event the event for data modification
    7676     */
    7777    void otherDatasetChange(AbstractDatasetChangedEvent event);
    … …  
    7979    /**
    8080     * Called after big changes in dataset. Usually other events are stopped using Dataset.beginUpdate() and
    81      * after operation is completed (Dataset.endUpdate()), {@link #dataChanged()} is called.
     81     * after operation is completed (Dataset.endUpdate()), {@link #dataChanged(DataChangedEvent event)} is called.
    8282     */
    8383    void dataChanged(DataChangedEvent event);

  • trunk/src/org/openstreetmap/josm/data/osm/event/DatasetEventManager.java

    r5170 r5881  
    2222 * new layer is selected)
    2323 *
    24  * Events in EDT are supported, see {@link #addDatasetListener(DataSetListener, FireMode}
     24 * Events in EDT are supported, see {@link #addDatasetListener(DataSetListener, FireMode)}
    2525 *
    2626 */

  • trunk/src/org/openstreetmap/josm/data/osm/visitor/paint/WireframeMapRenderer.java

    r5754 r5881  
    8383    private DataSet ds;
    8484
    85     /** Helper variable for {@link #drawSgement} */
     85    /** Helper variable for {@link #drawSegment} */
    8686    private static final double PHI = Math.toRadians(20);
    87     /** Helper variable for {@link #drawSgement} */
     87    /** Helper variable for {@link #drawSegment} */
    8888    private static final double cosPHI = Math.cos(PHI);
    89     /** Helper variable for {@link #drawSgement} */
     89    /** Helper variable for {@link #drawSegment} */
    9090    private static final double sinPHI = Math.sin(PHI);
    9191
Note: See TracChangeset for help on using the changeset viewer.