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

fix all remaining javadoc warnings

Location:
trunk/src/org/openstreetmap/josm/actions
Files:
11 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 {
Note: See TracChangeset for help on using the changeset viewer.