Ignore:
Timestamp:
2015-06-03T13:24:59+02:00 (11 years ago)
Author:
Don-vip
Message:

javadoc / Unit test fixes

Location:
trunk/src/org/openstreetmap/josm/gui
Files:
5 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/org/openstreetmap/josm/gui/FileDrop.java

    r8443 r8459  
    3434import org.openstreetmap.josm.Main;
    3535import org.openstreetmap.josm.actions.OpenFileAction;
     36import org.openstreetmap.josm.gui.FileDrop.TransferableObject;
    3637
    3738/**
    … …  
    538539         * {@link #DATA_FLAVOR}.
    539540         *
     541         * @param fetcher The {@link Fetcher} that will return the data object
    540542         * @see Fetcher
    541          * @param fetcher The {@link Fetcher} that will return the data object
    542543         */
    543544        public TransferableObject(Fetcher fetcher) {

  • trunk/src/org/openstreetmap/josm/gui/MenuScroller.java

    r8441 r8459  
    151151     * @param interval the scroll interval, in milliseconds
    152152     * @param topFixedCount the number of items to fix at the top.  May be 0.
     153     * @return the MenuScroller
    153154     * @throws IllegalArgumentException if scrollCount or interval is 0 or
    154155     * negative or if topFixedCount is negative
    155      * @return the MenuScroller
    156156     * @since 7463
    157157     */
    … …  
    167167     * @param interval the scroll interval, in milliseconds
    168168     * @param topFixedCount the number of items to fix at the top. May be 0
     169     * @return the MenuScroller
    169170     * @throws IllegalArgumentException if scrollCount or interval is 0 or
    170171     * negative or if topFixedCount is negative
    171      * @return the MenuScroller
    172172     * @since 7463
    173173     */

  • trunk/src/org/openstreetmap/josm/gui/NavigatableComponent.java

    r8443 r8459  
    822822     *
    823823     * Finally, if a node is not found at all, null is returned.
    824      * @since 6065
    825      * @return A node within snap-distance to point p,
    826      *      that is chosen by the algorithm described.
    827824     *
    828825     * @param p the screen point
    … …  
    830827     *        give the nearest node that is tagged.
    831828     * @param preferredRefs primitives, whose nodes we prefer
     829     *
     830     * @return A node within snap-distance to point p,
     831     *      that is chosen by the algorithm described.
     832     * @since 6065
    832833     */
    833834    public final Node getNearestNode(Point p, Predicate<OsmPrimitive> predicate,
    … …  
    10091010     * The *result* depends on the current map selection state IF use_selected is true.
    10101011     *
     1012     * @param p the point for which to search the nearest segment.
     1013     * @param predicate the returned object has to fulfill certain properties.
     1014     * @param useSelected whether selected way segments should be preferred.
     1015     *
    10111016     * @return The nearest way segment to point p,
    10121017     *      and, depending on use_selected, prefers a selected way segment, if found.
    10131018     * @see #getNearestWaySegments(Point, Collection, Predicate)
    1014      *
    1015      * @param p the point for which to search the nearest segment.
    1016      * @param predicate the returned object has to fulfill certain properties.
    1017      * @param useSelected whether selected way segments should be preferred.
    10181019     */
    10191020    public final WaySegment getNearestWaySegment(Point p, Predicate<OsmPrimitive> predicate, boolean useSelected) {
    … …  
    10401041     * The *result* depends on the current map selection state IF use_selected is true.
    10411042     *
    1042      * @return The nearest way segment to point p,
    1043      *      and, depending on use_selected, prefers a selected way segment, if found.
    1044      * Also prefers segments of ways that are related to one of preferredRefs primitives
    1045      * @see #getNearestWaySegments(Point, Collection, Predicate)
    1046      * @since 6065
    10471043     * @param p the point for which to search the nearest segment.
    10481044     * @param predicate the returned object has to fulfill certain properties.
    10491045     * @param use_selected whether selected way segments should be preferred.
    10501046     * @param preferredRefs - prefer segments related to these primitives, may be null
     1047     *
     1048     * @return The nearest way segment to point p,
     1049     *      and, depending on use_selected, prefers a selected way segment, if found.
     1050     * Also prefers segments of ways that are related to one of preferredRefs primitives
     1051     *
     1052     * @see #getNearestWaySegments(Point, Collection, Predicate)
     1053     * @since 6065
    10511054     */
    10521055    public final WaySegment getNearestWaySegment(Point p, Predicate<OsmPrimitive> predicate,
    … …  
    11501153     * The *result* depends on the current map selection state.
    11511154     *
    1152      * @return The nearest way to point p,
    1153      *      prefer a selected way if there are multiple nearest.
    1154      * @see #getNearestWaySegment(Point, Predicate)
    1155      *
    11561155     * @param p the point for which to search the nearest segment.
    11571156     * @param predicate the returned object has to fulfill certain properties.
     1157     *
     1158     * @return The nearest way to point p, prefer a selected way if there are multiple nearest.
     1159     * @see #getNearestWaySegment(Point, Predicate)
    11581160     */
    11591161    public final Way getNearestWay(Point p, Predicate<OsmPrimitive> predicate) {
    … …  
    12491251     * Finally, if no nearest primitive is found at all, return null.
    12501252     *
     1253     * @param p The point on screen.
     1254     * @param predicate the returned object has to fulfill certain properties.
     1255     * @param use_selected whether to prefer primitives that are currently selected or referred by selected primitives
     1256     *
    12511257     * @return A primitive within snap-distance to point p,
    12521258     *      that is chosen by the algorithm described.
    12531259     * @see #getNearestNode(Point, Predicate)
    12541260     * @see #getNearestWay(Point, Predicate)
    1255      *
    1256      * @param p The point on screen.
    1257      * @param predicate the returned object has to fulfill certain properties.
    1258      * @param use_selected whether to prefer primitives that are currently selected or referred by selected primitives
    12591261     */
    12601262    public final OsmPrimitive getNearestNodeOrWay(Point p, Predicate<OsmPrimitive> predicate, boolean use_selected) {
    … …  
    13461348
    13471349    /**
    1348      * The *result* does not depend on the current map selection state,
    1349      * neither does the result *order*.
     1350     * The *result* does not depend on the current map selection state, neither does the result *order*.
    13501351     * It solely depends on the distance to point p.
    1351      *
    1352      * @return a list of all objects that are nearest to point p and
    1353      *          not in ignore or an empty list if nothing was found.
    13541352     *
    13551353     * @param p The point on screen.
    13561354     * @param ignore a collection of ways which are not to be returned.
    13571355     * @param predicate the returned object has to fulfill certain properties.
     1356     *
     1357     * @return a list of all objects that are nearest to point p and
     1358     *          not in ignore or an empty list if nothing was found.
    13581359     */
    13591360    public final List<OsmPrimitive> getAllNearest(Point p,
    … …  
    13951396
    13961397    /**
    1397      * The *result* does not depend on the current map selection state,
    1398      * neither does the result *order*.
     1398     * The *result* does not depend on the current map selection state, neither does the result *order*.
    13991399     * It solely depends on the distance to point p.
     1400     *
     1401     * @param p The point on screen.
     1402     * @param predicate the returned object has to fulfill certain properties.
    14001403     *
    14011404     * @return a list of all objects that are nearest to point p
    14021405     *          or an empty list if nothing was found.
    14031406     * @see #getAllNearest(Point, Collection, Predicate)
    1404      *
    1405      * @param p The point on screen.
    1406      * @param predicate the returned object has to fulfill certain properties.
    14071407     */
    14081408    public final List<OsmPrimitive> getAllNearest(Point p, Predicate<OsmPrimitive> predicate) {

  • trunk/src/org/openstreetmap/josm/gui/mappaint/Environment.java

    r8419 r8459  
    148148     * @param count count of nodes in parent way or members in parent relation
    149149     * @return A clone of this environment, with the specified child, index, and context set to {@code Context#LINK}
    150      * @since 6175
    151150     * @see #child
    152151     * @see #index
     152     * @since 6175
    153153     */
    154154    public Environment withChildAndIndexAndLinkContext(OsmPrimitive child, int index, int count) {

  • trunk/src/org/openstreetmap/josm/gui/mappaint/mapcss/ExpressionFactory.java

    r8440 r8459  
    578578         * {@code sw}, {@code southwest}, {@code w}, {@code west}, {@code nw}, {@code northwest}.
    579579         * @param cardinal the angle in cardinal directions.
     580         * @return the angle in radians
    580581         * @see RotationAngle#parseCardinalRotation(String)
    581          * @return the angle in radians
    582582         */
    583583        public static Double cardinal_to_radians(String cardinal) {
Note: See TracChangeset for help on using the changeset viewer.