Changeset 5909 in josm


Ignore:
Timestamp:
2013-04-29T00:09:53+02:00 (7 years ago)
Author:
stoecker
Message:

fix all remaining javadoc warnings

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

Legend:

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

    r5459 r5909  
    2424    /**
    2525     * Construct the action with "Save" as label.
    26      * @param layer Save this layer.
    2726     */
    2827    private SaveAction() {
  • trunk/src/org/openstreetmap/josm/actions/UnGlueAction.java

    r4982 r5909  
    183183     * node is only part of one or less ways.
    184184     *
    185      * @param The selection to check against
    186      * @return Selection is suitable
     185     * @param selection The selection to check against
     186     * @return {@code true} if selection is suitable
    187187     */
    188188    private boolean checkForUnglueNode(Collection<? extends OsmPrimitive> selection) {
  • trunk/src/org/openstreetmap/josm/actions/UploadSelectionAction.java

    r5711 r5909  
    294294         * there are dangling references on the server.
    295295         *
    296          * @return
     296         * @return primitives to check
    297297         */
    298298        protected Set<OsmPrimitive> getPrimitivesToCheckForParents() {
  • trunk/src/org/openstreetmap/josm/actions/downloadtasks/DownloadOsmChangeCompressedTask.java

    r5486 r5909  
    2222    /**
    2323     * Loads a given URL
    24      * @param True if the data should be saved to a new layer
    25      * @param The URL as String
     24     * @param new_layer {@code true} if the data should be saved to a new layer
     25     * @param url The URL as String
     26     * @param progressMonitor progress monitor for user interaction
    2627     */
    2728    public Future<?> loadUrl(boolean new_layer, final String url, ProgressMonitor progressMonitor) {
  • trunk/src/org/openstreetmap/josm/actions/downloadtasks/DownloadOsmCompressedTask.java

    r5486 r5909  
    3232    /**
    3333     * Loads a given URL
    34      * @param True if the data should be saved to a new layer
    35      * @param The URL as String
     34     * @param new_layer {@code true} if the data should be saved to a new layer
     35     * @param url The URL as String
     36     * @param progressMonitor progress monitor for user interaction
    3637     */
    3738    public Future<?> loadUrl(boolean new_layer, final String url, ProgressMonitor progressMonitor) {
  • trunk/src/org/openstreetmap/josm/actions/downloadtasks/DownloadReferrersTask.java

    r4310 r5909  
    7878     *
    7979     * @param targetLayer  the target layer for the downloaded primitives. Must not be null.
    80      * @param primitives  the collection of children for which parents are to be downloaded. Children
     80     * @param children  the collection of children for which parents are to be downloaded. Children
    8181     * are specified by their id and  their type.
    82      *
    8382     */
    8483    public DownloadReferrersTask(OsmDataLayer targetLayer, Map<Long, OsmPrimitiveType> children) {
  • trunk/src/org/openstreetmap/josm/actions/mapmode/DeleteAction.java

    r5460 r5909  
    384384     * that should be deleted but does not actually delete them.
    385385     * @param e MouseEvent from which modifiers and position are taken
    386      * @param modifiers For explanation: @see updateCursor
    387      * @param silet Set to true if the user should not be bugged with additional
     386     * @param modifiers For explanation, see {@link #updateCursor}
     387     * @param silent Set to true if the user should not be bugged with additional
    388388     *        dialogs
    389      * @return
     389     * @return delete command
    390390     */
    391391    private Command buildDeleteCommands(MouseEvent e, int modifiers, boolean silent) {
  • trunk/src/org/openstreetmap/josm/actions/mapmode/DrawAction.java

    r5820 r5909  
    684684
    685685    /**
    686      * Prevent creation of ways that look like this: <---->
     686     * Prevent creation of ways that look like this: &lt;----&gt;
    687687     * This happens if users want to draw a no-exit-sideway from the main way like this:
    688688     * ^
    689      * |<---->
     689     * |&lt;----&gt;
    690690     * |
    691691     * The solution isn't ideal because the main way will end in the side way, which is bad for
     
    693693     * it on their own, too. At least it's better than producing an error.
    694694     *
    695      * @param Way the way to check
    696      * @param Node the current node (i.e. the one the connection will be made from)
    697      * @param Node the target node (i.e. the one the connection will be made to)
    698      * @return Boolean True if this would create a selfcontaining way, false otherwise.
     695     * @param selectedWay the way to check
     696     * @param currentNode the current node (i.e. the one the connection will be made from)
     697     * @param targetNode the target node (i.e. the one the connection will be made to)
     698     * @return {@code true} if this would create a selfcontaining way, {@code false} otherwise.
    699699     */
    700700    private boolean isSelfContainedWay(Way selectedWay, Node currentNode, Node targetNode) {
  • trunk/src/org/openstreetmap/josm/actions/mapmode/ImproveWayAccuracyHelper.java

    r4846 r5909  
    2828     * the ways containing it. If the mouse is on the way, simply returns it.
    2929     *
    30      * @param mv
    31      * @param p
    32      * @return Way or null in case there is nothing under the cursor.
     30     * @param mv the current map view
     31     * @param p the cursor position
     32     * @return {@code Way} or {@code null} in case there is nothing under the cursor.
    3333     */
    3434    public static Way findWay(MapView mv, Point p) {
     
    6464     * candidateNode to a new place.
    6565     *
    66      * @param mv
    67      * @param w
    68      * @param p
    69      * @return
     66     * @param mv the current map view
     67     * @param w the way to check
     68     * @param p the cursor position
     69     * @return nearest node to cursor
    7070     */
    7171    public static Node findCandidateNode(MapView mv, Way w, Point p) {
     
    114114     * with the largest angle apb is chosen.
    115115     *
    116      * @param mv
    117      * @param w
    118      * @param p
    119      * @return
     116     * @param mv the current map view
     117     * @param w the way to check
     118     * @param p the cursor position
     119     * @return nearest way segment to cursor
    120120     */
    121121    public static WaySegment findCandidateSegment(MapView mv, Way w, Point p) {
  • trunk/src/org/openstreetmap/josm/actions/mapmode/SelectAction.java

    r5735 r5909  
    228228     * handles adding highlights and updating the cursor for the given mouse event.
    229229     * Please note that the highlighting for merging while moving is handled via mouseDragged.
    230      * @param MouseEvent which should be used as base for the feedback
    231      * @return true if repaint is required
     230     * @param e {@code MouseEvent} which should be used as base for the feedback
     231     * @return {@code true} if repaint is required
    232232     */
    233233    private boolean giveUserFeedback(MouseEvent e) {
     
    238238     * handles adding highlights and updating the cursor for the given mouse event.
    239239     * Please note that the highlighting for merging while moving is handled via mouseDragged.
    240      * @param MouseEvent which should be used as base for the feedback
    241      * @param define custom keyboard modifiers if the ones from MouseEvent are outdated or similar
    242      * @return true if repaint is required
     240     * @param e {@code MouseEvent} which should be used as base for the feedback
     241     * @param modifiers define custom keyboard modifiers if the ones from MouseEvent are outdated or similar
     242     * @return {@code true} if repaint is required
    243243     */
    244244    private boolean giveUserFeedback(MouseEvent e, int modifiers) {
     
    10581058         * <code>virtualWays</code>.
    10591059         *
    1060          * @param e contains the point clicked
     1060         * @param p the point clicked
    10611061         * @return whether
    10621062         * <code>virtualNode</code> and
  • trunk/src/org/openstreetmap/josm/actions/search/SearchCompiler.java

    r5848 r5909  
    12041204     *
    12051205     * @param errorMessage to display if parsing error occurs
    1206      * @return
     1206     * @return match determined by parsing expression
    12071207     * @throws org.openstreetmap.josm.actions.search.SearchCompiler.ParseError
     1208     * @see #parseExpression()
    12081209     */
    12091210    private Match parseExpression(String errorMessage) throws ParseError {
  • trunk/src/org/openstreetmap/josm/data/conflict/ConflictCollection.java

    r5266 r5909  
    163163     * if no such conflict exists.
    164164     *
    165      * @param my  my primitive
     165     * @param their their primitive
    166166     * @return the conflict for the {@link OsmPrimitive} <code>their</code>, null
    167167     * if no such conflict exists.
  • trunk/src/org/openstreetmap/josm/data/coor/LatLon.java

    r5523 r5909  
    9292     * Returns a valid OSM longitude [-180,+180] for the given extended longitude value.
    9393     * For example, a value of -181 will return +179, a value of +181 will return -179.
    94      * @param lon A longitude value not restricted to the [-180,+180] range.
     94     * @param value A longitude value not restricted to the [-180,+180] range.
    9595     */
    9696    public static double toIntervalLon(double value) {
  • trunk/src/org/openstreetmap/josm/data/gpx/WayPoint.java

    r4431 r5909  
    7979     *
    8080     * <p><strong>Caveat:</strong> doesn't listen to projection changes. Clients must
    81      * {@link #reproject() trigger a reprojection} or {@link #invalidateEastNorthCache() invalidate the internal cache}.</p>
     81     * {@link #invalidateEastNorthCache() invalidate the internal cache}.</p>
    8282     *
    8383     * @return the east north coordinates or {@code null}
    8484     * @see #invalidateEastNorthCache()
    85      *
    8685     */
    8786    public final EastNorth getEastNorth() {
  • trunk/src/org/openstreetmap/josm/data/osm/FilterMatcher.java

    r5442 r5909  
    1717 * filters to a primitive.
    1818 *
    19  * Uses {@link SearchCompiler.Match#match} to see if the filter expression matches,
     19 * Uses {@link Match#match} to see if the filter expression matches,
    2020 * cares for "inverted-flag" of the filters and combines the results of all active
    2121 * filters.
  • trunk/src/org/openstreetmap/josm/data/osm/MultipolygonCreate.java

    r3704 r5909  
    3535        /**
    3636         * Creates a polygon from single way.
    37          * @param way
     37         * @param way the way to form the polygon
    3838         */
    3939        public JoinedPolygon(Way way) {
     
    4646        /**
    4747         * Builds a list of nodes for this polygon. First node is not duplicated as last node.
    48          * @return
     48         * @return list of nodes
    4949         */
    5050        private List<Node> getNodes() {
     
    103103
    104104    /**
    105      * Splits ways into inner and outer JoinedWays. Sets innerWays and outerWays to the result.
    106      *  TODO: Currently cannot process touching polygons. See code in JoinAreasAction.
    107      * @return error description if the ways cannot be split. Null if all fine.
     105     * Splits ways into inner and outer JoinedWays. Sets {@link #innerWays} and {@link #outerWays} to the result.
     106     * TODO: Currently cannot process touching polygons. See code in JoinAreasAction.
     107     * @param ways ways to analyze
     108     * @return error description if the ways cannot be split, {@code null} if all fine.
    108109     */
    109110    public String makeFromWays(Collection<Way> ways){
     
    185186
    186187    /**
    187      * This method analyzes which ways are inner and which outer. Sets innerWays and outerWays to the result.
    188      * @param joinedWays
    189      * @return error description if the ways cannot be split. Null if all fine.
     188     * This method analyzes which ways are inner and which outer. Sets {@link #innerWays} and {@link #outerWays} to the result.
     189     * @param polygons polygons to analyze
     190     * @return error description if the ways cannot be split, {@code null} if all fine.
    190191     */
    191192    private String makeFromPolygons(List<JoinedPolygon> polygons) {
     
    215216     * Collects outer way and corresponding inner ways from all boundaries.
    216217     * @param boundaryWays
    217      * @return the outermostWay, or null if intersection found.
     218     * @return the outermostWay, or {@code null} if intersection found.
    218219     */
    219220    private List<PolygonLevel> findOuterWaysRecursive(int level, Collection<JoinedPolygon> boundaryWays) {
  • trunk/src/org/openstreetmap/josm/data/osm/TagCollection.java

    r5724 r5909  
    582582     * Replies true if for every key there is one tag only, i.e. exactly one value.
    583583     *
    584      * @return
     584     * @return {@code true} if for every key there is one tag only
    585585     */
    586586    public boolean isApplicableToPrimitive() {
  • trunk/src/org/openstreetmap/josm/data/osm/WaySegment.java

    r5783 r5909  
    2222    }
    2323
    24     public Node getFirstNode(){
     24    /**
     25     * Returns the first node of the way segment.
     26     * @return the first node
     27     */
     28    public Node getFirstNode() {
    2529        return way.getNode(lowerIndex);
    2630    }
    2731
     32    /**
     33     * Returns the second (last) node of the way segment.
     34     * @return the second node
     35     */
    2836    public Node getSecondNode(){
    2937        return way.getNode(lowerIndex + 1);
     
    3139
    3240    /**
    33      * returns this way segment as complete way.
    34      * @return
     41     * Returns this way segment as complete way.
     42     * @return the way segment as {@code Way}
    3543     */
    3644    public Way toWay() {
  • trunk/src/org/openstreetmap/josm/data/osm/event/DatasetEventManager.java

    r5881 r5909  
    3030
    3131    public enum FireMode {
     32        /**
     33         * Fire in calling thread immediately.
     34         */
    3235        IMMEDIATELY,
     36        /**
     37         * Fire in event dispatch thread.
     38         */
    3339        IN_EDT,
    3440        /**
     
    7379    /**
    7480     * Register listener, that will receive events from currently active dataset
    75      * @param listener
    76      * @param fireInEDT If true, listener will be notified in event dispatch thread
    77      * instead of thread that caused the dataset change
     81     * @param listener the listener to be registered
     82     * @param fireMode If {@link FireMode#IN_EDT} or {@link FireMode#IN_EDT_CONSOLIDATED},
     83     * listener will be notified in event dispatch thread instead of thread that caused
     84     * the dataset change
    7885     */
    7986    public void addDatasetListener(DataSetListener listener, FireMode fireMode) {
  • trunk/src/org/openstreetmap/josm/data/osm/visitor/paint/MapRendererFactory.java

    r4932 r5909  
    8989    /**
    9090     * Replies the unique instance
    91      * @return
     91     * @return instance of map rending class
    9292     */
    9393    public static MapRendererFactory getInstance() {
  • trunk/src/org/openstreetmap/josm/data/projection/datum/NTV2SubGrid.java

    r5073 r5909  
    335335    }
    336336    /**
    337      * @return
     337     * Get maximum latitude value
     338     * @return maximum latitude
    338339     */
    339340    public double getMaxLat() {
     
    342343
    343344    /**
    344      * @return
     345     * Get maximum longitude value
     346     * @return maximum longitude
    345347     */
    346348    public double getMaxLon() {
     
    349351
    350352    /**
    351      * @return
     353     * Get minimum latitude value
     354     * @return minimum latitude
    352355     */
    353356    public double getMinLat() {
     
    356359
    357360    /**
    358      * @return
     361     * Get minimum longitude value
     362     * @return minimum longitude
    359363     */
    360364    public double getMinLon() {
  • trunk/src/org/openstreetmap/josm/data/validation/PaintVisitor.java

    r5681 r5909  
    242242     * NOTE: This will return true for a small number of non-visible
    243243     *       segments.
    244      * @param ls The segment to check
    245      * @return true if the segment is visible
     244     * @param n1 The first point of the segment to check
     245     * @param n2 The second point of the segment to check
     246     * @return {@code true} if the segment is visible
    246247     */
    247248    protected boolean isSegmentVisible(Node n1, Node n2) {
  • trunk/src/org/openstreetmap/josm/data/validation/tests/PowerLines.java

    r5359 r5909  
    137137     * Determines if the specified way denotes a power line.
    138138     * @param w The way to be tested
    139      * @return True if power key is set and equal to line/minor_line
     139     * @return {@code true} if power key is set and equal to line/minor_line
    140140     */
    141141    protected static final boolean isPowerLine(Way w) {
     
    145145    /**
    146146     * Determines if the specified primitive denotes a power station.
    147      * @param w The way to be tested
    148      * @return True if power key is set and equal to station/sub_station/plant
     147     * @param p The primitive to be tested
     148     * @return {@code true} if power key is set and equal to station/sub_station/plant
    149149     */
    150150    protected static final boolean isPowerStation(OsmPrimitive p) {
     
    154154    /**
    155155     * Determines if the specified node denotes a power tower/pole.
    156      * @param w The node to be tested
    157      * @return True if power key is set and equal to tower/pole
     156     * @param n The node to be tested
     157     * @return {@code true} if power key is set and equal to tower/pole
    158158     */
    159159    protected static final boolean isPowerTower(Node n) {
     
    163163    /**
    164164     * Determines if the specified node denotes a power infrastructure allowed on a power line.
    165      * @param w The node to be tested
     165     * @param n The node to be tested
    166166     * @return True if power key is set and equal to switch/tranformer/busbar/generator
    167167     */
     
    170170    }
    171171   
     172    /**
     173     * Helper function to check if power tags is a certain value.
     174     * @param p The primitive to be tested
     175     * @param values List of possible values
     176     * @return {@code true} if power key is set and equal to possible values
     177     */
    172178    private static final boolean isPowerIn(OsmPrimitive p, Collection<String> values) {
    173179        String v = p.get("power");
  • trunk/src/org/openstreetmap/josm/gui/ExtendedDialog.java

    r5646 r5909  
    548548     * Used in combination with toggle:
    549549     * If the user presses 'cancel' the toggle settings are ignored and not saved to the pref
    550      * @param cancelButton index of the button that stands for cancel, accepts
    551      *                     multiple values
     550     * @param cancelButtonIdx index of the button that stands for cancel, accepts multiple values
    552551     */
    553552    public ExtendedDialog setCancelButton(Integer... cancelButtonIdx) {
  • trunk/src/org/openstreetmap/josm/gui/HelpAwareOptionPane.java

    r5886 r5909  
    238238
    239239    /**
    240      *
    241      * @param parentComponent
    242      * @param msg
    243      * @param title
    244      * @param messageType
    245      * @param helpTopic
    246      * @return
     240     * Displays an option dialog which is aware of a help context.
     241     *
     242     * @param parentComponent the parent component
     243     * @param msg the message
     244     * @param title the title
     245     * @param messageType the message type (see {@link JOptionPane})
     246     * @param helpTopic the help topic. Can be null.
     247     * @return the index of the selected option or {@link JOptionPane#CLOSED_OPTION}
    247248     * @see #showOptionDialog(Component, Object, String, int, Icon, ButtonSpec[], ButtonSpec, String)
    248249     */
  • trunk/src/org/openstreetmap/josm/gui/JosmUserIdentityManager.java

    r5469 r5909  
    112112     * verified pair of user name and user id.
    113113     *
    114      * @param userName the user name. Must not be null. Must not be empty.
     114     * @param username the user name. Must not be null. Must not be empty.
    115115     * @param userinfo additional information about the user, retrieved from the OSM server and including the user id
    116116     * @throws IllegalArgumentException thrown if userName is null
     
    130130     * Replies true if the current JOSM user is anonymous.
    131131     *
    132      * @return true if the current user is anonymous.
     132     * @return {@code true} if the current user is anonymous.
    133133     */
    134134    public boolean isAnonymous() {
  • trunk/src/org/openstreetmap/josm/gui/MapFrame.java

    r5897 r5909  
    148148     * Constructs a new {@code MapFrame}.
    149149     * @param contentPane The content pane used to register shortcuts in its
    150      * {@link InputMap} and {@link ActionMap}
     150     * {@link javax.swing.InputMap} and {@link javax.swing.ActionMap}
    151151     * @param viewportData the initial viewport of the map. Can be null, then
    152152     * the viewport is derived from the layer data.
     
    338338    /**
    339339     * Fires an property changed event "visible".
     340     * @param aFlag {@code true} if display should be visible
    340341     */
    341342    @Override public void setVisible(boolean aFlag) {
     
    352353     * if new map mode is correct mode for current layer and does not change mode
    353354     * in such cases.
    354      * @param mapMode  The new mode to set.
    355      * @return
     355     * @param newMapMode The new mode to set.
     356     * @return {@code true} if mode is really selected
    356357     */
    357358    public boolean selectMapMode(MapMode newMapMode) {
     
    362363     * Another version of the selectMapMode for changing layer action.
    363364     * Pass newly selected layer to this method.
    364      * @param newMapMode
    365      * @param newLayer
    366      * @return True if mode is really selected
     365     * @param newMapMode The new mode to set.
     366     * @param newLayer newly selected layer
     367     * @return {@code true} if mode is really selected
    367368     */
    368369    public boolean selectMapMode(MapMode newMapMode, Layer newLayer) {
  • trunk/src/org/openstreetmap/josm/gui/MapStatus.java

    r5886 r5909  
    411411         * Call this with a set of primitives to cycle through them. Method
    412412         * will automatically select the next item and update the map
    413          * @param osms
    414          * @param mouse modifiers
     413         * @param osms primitives to cycle through
     414         * @param mods modifiers (i.e. control keys)
    415415         */
    416416        private final void popupCycleSelection(Collection<OsmPrimitive> osms, int mods) {
     
    452452        /**
    453453         * Tries to hide the given popup
    454          * @param popup
    455454         */
    456455        private final void popupHidePopup() {
     
    465464
    466465        /**
    467          * Tries to show the given popup, can be hidden using popupHideOldPopup
     466         * Tries to show the given popup, can be hidden using {@link #popupHidePopup}
    468467         * If an old popup exists, it will be automatically hidden
    469          * @param popup
     468         * @param newPopup popup to show
     469         * @param lbls lables to show (see {@link #popupLabels})
    470470         */
    471471        private final void popupShowPopup(Popup newPopup, List<JLabel> lbls) {
     
    525525         * given OsmPrimitive
    526526         * @param osm  The primitive to create the label for
    527          * @return
     527         * @return labels for info popup
    528528         */
    529529        private final JLabel popupBuildPrimitiveLabels(final OsmPrimitive osm) {
Note: See TracChangeset for help on using the changeset viewer.