Index: /trunk/src/org/openstreetmap/josm/actions/SaveAction.java =================================================================== --- /trunk/src/org/openstreetmap/josm/actions/SaveAction.java (revision 5908) +++ /trunk/src/org/openstreetmap/josm/actions/SaveAction.java (revision 5909) @@ -24,5 +24,4 @@ /** * Construct the action with "Save" as label. - * @param layer Save this layer. */ private SaveAction() { Index: /trunk/src/org/openstreetmap/josm/actions/UnGlueAction.java =================================================================== --- /trunk/src/org/openstreetmap/josm/actions/UnGlueAction.java (revision 5908) +++ /trunk/src/org/openstreetmap/josm/actions/UnGlueAction.java (revision 5909) @@ -183,6 +183,6 @@ * node is only part of one or less ways. * - * @param The selection to check against - * @return Selection is suitable + * @param selection The selection to check against + * @return {@code true} if selection is suitable */ private boolean checkForUnglueNode(Collection selection) { Index: /trunk/src/org/openstreetmap/josm/actions/UploadSelectionAction.java =================================================================== --- /trunk/src/org/openstreetmap/josm/actions/UploadSelectionAction.java (revision 5908) +++ /trunk/src/org/openstreetmap/josm/actions/UploadSelectionAction.java (revision 5909) @@ -294,5 +294,5 @@ * there are dangling references on the server. * - * @return + * @return primitives to check */ protected Set getPrimitivesToCheckForParents() { Index: /trunk/src/org/openstreetmap/josm/actions/downloadtasks/DownloadOsmChangeCompressedTask.java =================================================================== --- /trunk/src/org/openstreetmap/josm/actions/downloadtasks/DownloadOsmChangeCompressedTask.java (revision 5908) +++ /trunk/src/org/openstreetmap/josm/actions/downloadtasks/DownloadOsmChangeCompressedTask.java (revision 5909) @@ -22,6 +22,7 @@ /** * Loads a given URL - * @param True if the data should be saved to a new layer - * @param The URL as String + * @param new_layer {@code true} if the data should be saved to a new layer + * @param url The URL as String + * @param progressMonitor progress monitor for user interaction */ public Future loadUrl(boolean new_layer, final String url, ProgressMonitor progressMonitor) { Index: /trunk/src/org/openstreetmap/josm/actions/downloadtasks/DownloadOsmCompressedTask.java =================================================================== --- /trunk/src/org/openstreetmap/josm/actions/downloadtasks/DownloadOsmCompressedTask.java (revision 5908) +++ /trunk/src/org/openstreetmap/josm/actions/downloadtasks/DownloadOsmCompressedTask.java (revision 5909) @@ -32,6 +32,7 @@ /** * Loads a given URL - * @param True if the data should be saved to a new layer - * @param The URL as String + * @param new_layer {@code true} if the data should be saved to a new layer + * @param url The URL as String + * @param progressMonitor progress monitor for user interaction */ public Future loadUrl(boolean new_layer, final String url, ProgressMonitor progressMonitor) { Index: /trunk/src/org/openstreetmap/josm/actions/downloadtasks/DownloadReferrersTask.java =================================================================== --- /trunk/src/org/openstreetmap/josm/actions/downloadtasks/DownloadReferrersTask.java (revision 5908) +++ /trunk/src/org/openstreetmap/josm/actions/downloadtasks/DownloadReferrersTask.java (revision 5909) @@ -78,7 +78,6 @@ * * @param targetLayer the target layer for the downloaded primitives. Must not be null. - * @param primitives the collection of children for which parents are to be downloaded. Children + * @param children the collection of children for which parents are to be downloaded. Children * are specified by their id and their type. - * */ public DownloadReferrersTask(OsmDataLayer targetLayer, Map children) { Index: /trunk/src/org/openstreetmap/josm/actions/mapmode/DeleteAction.java =================================================================== --- /trunk/src/org/openstreetmap/josm/actions/mapmode/DeleteAction.java (revision 5908) +++ /trunk/src/org/openstreetmap/josm/actions/mapmode/DeleteAction.java (revision 5909) @@ -384,8 +384,8 @@ * that should be deleted but does not actually delete them. * @param e MouseEvent from which modifiers and position are taken - * @param modifiers For explanation: @see updateCursor - * @param silet Set to true if the user should not be bugged with additional + * @param modifiers For explanation, see {@link #updateCursor} + * @param silent Set to true if the user should not be bugged with additional * dialogs - * @return + * @return delete command */ private Command buildDeleteCommands(MouseEvent e, int modifiers, boolean silent) { Index: /trunk/src/org/openstreetmap/josm/actions/mapmode/DrawAction.java =================================================================== --- /trunk/src/org/openstreetmap/josm/actions/mapmode/DrawAction.java (revision 5908) +++ /trunk/src/org/openstreetmap/josm/actions/mapmode/DrawAction.java (revision 5909) @@ -684,8 +684,8 @@ /** - * Prevent creation of ways that look like this: <----> + * Prevent creation of ways that look like this: <----> * This happens if users want to draw a no-exit-sideway from the main way like this: * ^ - * |<----> + * |<----> * | * The solution isn't ideal because the main way will end in the side way, which is bad for @@ -693,8 +693,8 @@ * it on their own, too. At least it's better than producing an error. * - * @param Way the way to check - * @param Node the current node (i.e. the one the connection will be made from) - * @param Node the target node (i.e. the one the connection will be made to) - * @return Boolean True if this would create a selfcontaining way, false otherwise. + * @param selectedWay the way to check + * @param currentNode the current node (i.e. the one the connection will be made from) + * @param targetNode the target node (i.e. the one the connection will be made to) + * @return {@code true} if this would create a selfcontaining way, {@code false} otherwise. */ private boolean isSelfContainedWay(Way selectedWay, Node currentNode, Node targetNode) { Index: /trunk/src/org/openstreetmap/josm/actions/mapmode/ImproveWayAccuracyHelper.java =================================================================== --- /trunk/src/org/openstreetmap/josm/actions/mapmode/ImproveWayAccuracyHelper.java (revision 5908) +++ /trunk/src/org/openstreetmap/josm/actions/mapmode/ImproveWayAccuracyHelper.java (revision 5909) @@ -28,7 +28,7 @@ * the ways containing it. If the mouse is on the way, simply returns it. * - * @param mv - * @param p - * @return Way or null in case there is nothing under the cursor. + * @param mv the current map view + * @param p the cursor position + * @return {@code Way} or {@code null} in case there is nothing under the cursor. */ public static Way findWay(MapView mv, Point p) { @@ -64,8 +64,8 @@ * candidateNode to a new place. * - * @param mv - * @param w - * @param p - * @return + * @param mv the current map view + * @param w the way to check + * @param p the cursor position + * @return nearest node to cursor */ public static Node findCandidateNode(MapView mv, Way w, Point p) { @@ -114,8 +114,8 @@ * with the largest angle apb is chosen. * - * @param mv - * @param w - * @param p - * @return + * @param mv the current map view + * @param w the way to check + * @param p the cursor position + * @return nearest way segment to cursor */ public static WaySegment findCandidateSegment(MapView mv, Way w, Point p) { Index: /trunk/src/org/openstreetmap/josm/actions/mapmode/SelectAction.java =================================================================== --- /trunk/src/org/openstreetmap/josm/actions/mapmode/SelectAction.java (revision 5908) +++ /trunk/src/org/openstreetmap/josm/actions/mapmode/SelectAction.java (revision 5909) @@ -228,6 +228,6 @@ * handles adding highlights and updating the cursor for the given mouse event. * Please note that the highlighting for merging while moving is handled via mouseDragged. - * @param MouseEvent which should be used as base for the feedback - * @return true if repaint is required + * @param e {@code MouseEvent} which should be used as base for the feedback + * @return {@code true} if repaint is required */ private boolean giveUserFeedback(MouseEvent e) { @@ -238,7 +238,7 @@ * handles adding highlights and updating the cursor for the given mouse event. * Please note that the highlighting for merging while moving is handled via mouseDragged. - * @param MouseEvent which should be used as base for the feedback - * @param define custom keyboard modifiers if the ones from MouseEvent are outdated or similar - * @return true if repaint is required + * @param e {@code MouseEvent} which should be used as base for the feedback + * @param modifiers define custom keyboard modifiers if the ones from MouseEvent are outdated or similar + * @return {@code true} if repaint is required */ private boolean giveUserFeedback(MouseEvent e, int modifiers) { @@ -1058,5 +1058,5 @@ * virtualWays. * - * @param e contains the point clicked + * @param p the point clicked * @return whether * virtualNode and Index: /trunk/src/org/openstreetmap/josm/actions/search/SearchCompiler.java =================================================================== --- /trunk/src/org/openstreetmap/josm/actions/search/SearchCompiler.java (revision 5908) +++ /trunk/src/org/openstreetmap/josm/actions/search/SearchCompiler.java (revision 5909) @@ -1204,6 +1204,7 @@ * * @param errorMessage to display if parsing error occurs - * @return + * @return match determined by parsing expression * @throws org.openstreetmap.josm.actions.search.SearchCompiler.ParseError + * @see #parseExpression() */ private Match parseExpression(String errorMessage) throws ParseError { Index: /trunk/src/org/openstreetmap/josm/data/conflict/ConflictCollection.java =================================================================== --- /trunk/src/org/openstreetmap/josm/data/conflict/ConflictCollection.java (revision 5908) +++ /trunk/src/org/openstreetmap/josm/data/conflict/ConflictCollection.java (revision 5909) @@ -163,5 +163,5 @@ * if no such conflict exists. * - * @param my my primitive + * @param their their primitive * @return the conflict for the {@link OsmPrimitive} their, null * if no such conflict exists. Index: /trunk/src/org/openstreetmap/josm/data/coor/LatLon.java =================================================================== --- /trunk/src/org/openstreetmap/josm/data/coor/LatLon.java (revision 5908) +++ /trunk/src/org/openstreetmap/josm/data/coor/LatLon.java (revision 5909) @@ -92,5 +92,5 @@ * Returns a valid OSM longitude [-180,+180] for the given extended longitude value. * For example, a value of -181 will return +179, a value of +181 will return -179. - * @param lon A longitude value not restricted to the [-180,+180] range. + * @param value A longitude value not restricted to the [-180,+180] range. */ public static double toIntervalLon(double value) { Index: /trunk/src/org/openstreetmap/josm/data/gpx/WayPoint.java =================================================================== --- /trunk/src/org/openstreetmap/josm/data/gpx/WayPoint.java (revision 5908) +++ /trunk/src/org/openstreetmap/josm/data/gpx/WayPoint.java (revision 5909) @@ -79,9 +79,8 @@ * *

Caveat: doesn't listen to projection changes. Clients must - * {@link #reproject() trigger a reprojection} or {@link #invalidateEastNorthCache() invalidate the internal cache}.

+ * {@link #invalidateEastNorthCache() invalidate the internal cache}.

* * @return the east north coordinates or {@code null} * @see #invalidateEastNorthCache() - * */ public final EastNorth getEastNorth() { Index: /trunk/src/org/openstreetmap/josm/data/osm/FilterMatcher.java =================================================================== --- /trunk/src/org/openstreetmap/josm/data/osm/FilterMatcher.java (revision 5908) +++ /trunk/src/org/openstreetmap/josm/data/osm/FilterMatcher.java (revision 5909) @@ -17,5 +17,5 @@ * filters to a primitive. * - * Uses {@link SearchCompiler.Match#match} to see if the filter expression matches, + * Uses {@link Match#match} to see if the filter expression matches, * cares for "inverted-flag" of the filters and combines the results of all active * filters. Index: /trunk/src/org/openstreetmap/josm/data/osm/MultipolygonCreate.java =================================================================== --- /trunk/src/org/openstreetmap/josm/data/osm/MultipolygonCreate.java (revision 5908) +++ /trunk/src/org/openstreetmap/josm/data/osm/MultipolygonCreate.java (revision 5909) @@ -35,5 +35,5 @@ /** * Creates a polygon from single way. - * @param way + * @param way the way to form the polygon */ public JoinedPolygon(Way way) { @@ -46,5 +46,5 @@ /** * Builds a list of nodes for this polygon. First node is not duplicated as last node. - * @return + * @return list of nodes */ private List getNodes() { @@ -103,7 +103,8 @@ /** - * Splits ways into inner and outer JoinedWays. Sets innerWays and outerWays to the result. - * TODO: Currently cannot process touching polygons. See code in JoinAreasAction. - * @return error description if the ways cannot be split. Null if all fine. + * Splits ways into inner and outer JoinedWays. Sets {@link #innerWays} and {@link #outerWays} to the result. + * TODO: Currently cannot process touching polygons. See code in JoinAreasAction. + * @param ways ways to analyze + * @return error description if the ways cannot be split, {@code null} if all fine. */ public String makeFromWays(Collection ways){ @@ -185,7 +186,7 @@ /** - * This method analyzes which ways are inner and which outer. Sets innerWays and outerWays to the result. - * @param joinedWays - * @return error description if the ways cannot be split. Null if all fine. + * This method analyzes which ways are inner and which outer. Sets {@link #innerWays} and {@link #outerWays} to the result. + * @param polygons polygons to analyze + * @return error description if the ways cannot be split, {@code null} if all fine. */ private String makeFromPolygons(List polygons) { @@ -215,5 +216,5 @@ * Collects outer way and corresponding inner ways from all boundaries. * @param boundaryWays - * @return the outermostWay, or null if intersection found. + * @return the outermostWay, or {@code null} if intersection found. */ private List findOuterWaysRecursive(int level, Collection boundaryWays) { Index: /trunk/src/org/openstreetmap/josm/data/osm/TagCollection.java =================================================================== --- /trunk/src/org/openstreetmap/josm/data/osm/TagCollection.java (revision 5908) +++ /trunk/src/org/openstreetmap/josm/data/osm/TagCollection.java (revision 5909) @@ -582,5 +582,5 @@ * Replies true if for every key there is one tag only, i.e. exactly one value. * - * @return + * @return {@code true} if for every key there is one tag only */ public boolean isApplicableToPrimitive() { Index: /trunk/src/org/openstreetmap/josm/data/osm/WaySegment.java =================================================================== --- /trunk/src/org/openstreetmap/josm/data/osm/WaySegment.java (revision 5908) +++ /trunk/src/org/openstreetmap/josm/data/osm/WaySegment.java (revision 5909) @@ -22,8 +22,16 @@ } - public Node getFirstNode(){ + /** + * Returns the first node of the way segment. + * @return the first node + */ + public Node getFirstNode() { return way.getNode(lowerIndex); } + /** + * Returns the second (last) node of the way segment. + * @return the second node + */ public Node getSecondNode(){ return way.getNode(lowerIndex + 1); @@ -31,6 +39,6 @@ /** - * returns this way segment as complete way. - * @return + * Returns this way segment as complete way. + * @return the way segment as {@code Way} */ public Way toWay() { Index: /trunk/src/org/openstreetmap/josm/data/osm/event/DatasetEventManager.java =================================================================== --- /trunk/src/org/openstreetmap/josm/data/osm/event/DatasetEventManager.java (revision 5908) +++ /trunk/src/org/openstreetmap/josm/data/osm/event/DatasetEventManager.java (revision 5909) @@ -30,5 +30,11 @@ public enum FireMode { + /** + * Fire in calling thread immediately. + */ IMMEDIATELY, + /** + * Fire in event dispatch thread. + */ IN_EDT, /** @@ -73,7 +79,8 @@ /** * Register listener, that will receive events from currently active dataset - * @param listener - * @param fireInEDT If true, listener will be notified in event dispatch thread - * instead of thread that caused the dataset change + * @param listener the listener to be registered + * @param fireMode If {@link FireMode#IN_EDT} or {@link FireMode#IN_EDT_CONSOLIDATED}, + * listener will be notified in event dispatch thread instead of thread that caused + * the dataset change */ public void addDatasetListener(DataSetListener listener, FireMode fireMode) { Index: /trunk/src/org/openstreetmap/josm/data/osm/visitor/paint/MapRendererFactory.java =================================================================== --- /trunk/src/org/openstreetmap/josm/data/osm/visitor/paint/MapRendererFactory.java (revision 5908) +++ /trunk/src/org/openstreetmap/josm/data/osm/visitor/paint/MapRendererFactory.java (revision 5909) @@ -89,5 +89,5 @@ /** * Replies the unique instance - * @return + * @return instance of map rending class */ public static MapRendererFactory getInstance() { Index: /trunk/src/org/openstreetmap/josm/data/projection/datum/NTV2SubGrid.java =================================================================== --- /trunk/src/org/openstreetmap/josm/data/projection/datum/NTV2SubGrid.java (revision 5908) +++ /trunk/src/org/openstreetmap/josm/data/projection/datum/NTV2SubGrid.java (revision 5909) @@ -335,5 +335,6 @@ } /** - * @return + * Get maximum latitude value + * @return maximum latitude */ public double getMaxLat() { @@ -342,5 +343,6 @@ /** - * @return + * Get maximum longitude value + * @return maximum longitude */ public double getMaxLon() { @@ -349,5 +351,6 @@ /** - * @return + * Get minimum latitude value + * @return minimum latitude */ public double getMinLat() { @@ -356,5 +359,6 @@ /** - * @return + * Get minimum longitude value + * @return minimum longitude */ public double getMinLon() { Index: /trunk/src/org/openstreetmap/josm/data/validation/PaintVisitor.java =================================================================== --- /trunk/src/org/openstreetmap/josm/data/validation/PaintVisitor.java (revision 5908) +++ /trunk/src/org/openstreetmap/josm/data/validation/PaintVisitor.java (revision 5909) @@ -242,6 +242,7 @@ * NOTE: This will return true for a small number of non-visible * segments. - * @param ls The segment to check - * @return true if the segment is visible + * @param n1 The first point of the segment to check + * @param n2 The second point of the segment to check + * @return {@code true} if the segment is visible */ protected boolean isSegmentVisible(Node n1, Node n2) { Index: /trunk/src/org/openstreetmap/josm/data/validation/tests/PowerLines.java =================================================================== --- /trunk/src/org/openstreetmap/josm/data/validation/tests/PowerLines.java (revision 5908) +++ /trunk/src/org/openstreetmap/josm/data/validation/tests/PowerLines.java (revision 5909) @@ -137,5 +137,5 @@ * Determines if the specified way denotes a power line. * @param w The way to be tested - * @return True if power key is set and equal to line/minor_line + * @return {@code true} if power key is set and equal to line/minor_line */ protected static final boolean isPowerLine(Way w) { @@ -145,6 +145,6 @@ /** * Determines if the specified primitive denotes a power station. - * @param w The way to be tested - * @return True if power key is set and equal to station/sub_station/plant + * @param p The primitive to be tested + * @return {@code true} if power key is set and equal to station/sub_station/plant */ protected static final boolean isPowerStation(OsmPrimitive p) { @@ -154,6 +154,6 @@ /** * Determines if the specified node denotes a power tower/pole. - * @param w The node to be tested - * @return True if power key is set and equal to tower/pole + * @param n The node to be tested + * @return {@code true} if power key is set and equal to tower/pole */ protected static final boolean isPowerTower(Node n) { @@ -163,5 +163,5 @@ /** * Determines if the specified node denotes a power infrastructure allowed on a power line. - * @param w The node to be tested + * @param n The node to be tested * @return True if power key is set and equal to switch/tranformer/busbar/generator */ @@ -170,4 +170,10 @@ } + /** + * Helper function to check if power tags is a certain value. + * @param p The primitive to be tested + * @param values List of possible values + * @return {@code true} if power key is set and equal to possible values + */ private static final boolean isPowerIn(OsmPrimitive p, Collection values) { String v = p.get("power"); Index: /trunk/src/org/openstreetmap/josm/gui/ExtendedDialog.java =================================================================== --- /trunk/src/org/openstreetmap/josm/gui/ExtendedDialog.java (revision 5908) +++ /trunk/src/org/openstreetmap/josm/gui/ExtendedDialog.java (revision 5909) @@ -548,6 +548,5 @@ * Used in combination with toggle: * If the user presses 'cancel' the toggle settings are ignored and not saved to the pref - * @param cancelButton index of the button that stands for cancel, accepts - * multiple values + * @param cancelButtonIdx index of the button that stands for cancel, accepts multiple values */ public ExtendedDialog setCancelButton(Integer... cancelButtonIdx) { Index: /trunk/src/org/openstreetmap/josm/gui/HelpAwareOptionPane.java =================================================================== --- /trunk/src/org/openstreetmap/josm/gui/HelpAwareOptionPane.java (revision 5908) +++ /trunk/src/org/openstreetmap/josm/gui/HelpAwareOptionPane.java (revision 5909) @@ -238,11 +238,12 @@ /** - * - * @param parentComponent - * @param msg - * @param title - * @param messageType - * @param helpTopic - * @return + * Displays an option dialog which is aware of a help context. + * + * @param parentComponent the parent component + * @param msg the message + * @param title the title + * @param messageType the message type (see {@link JOptionPane}) + * @param helpTopic the help topic. Can be null. + * @return the index of the selected option or {@link JOptionPane#CLOSED_OPTION} * @see #showOptionDialog(Component, Object, String, int, Icon, ButtonSpec[], ButtonSpec, String) */ Index: /trunk/src/org/openstreetmap/josm/gui/JosmUserIdentityManager.java =================================================================== --- /trunk/src/org/openstreetmap/josm/gui/JosmUserIdentityManager.java (revision 5908) +++ /trunk/src/org/openstreetmap/josm/gui/JosmUserIdentityManager.java (revision 5909) @@ -112,5 +112,5 @@ * verified pair of user name and user id. * - * @param userName the user name. Must not be null. Must not be empty. + * @param username the user name. Must not be null. Must not be empty. * @param userinfo additional information about the user, retrieved from the OSM server and including the user id * @throws IllegalArgumentException thrown if userName is null @@ -130,5 +130,5 @@ * Replies true if the current JOSM user is anonymous. * - * @return true if the current user is anonymous. + * @return {@code true} if the current user is anonymous. */ public boolean isAnonymous() { Index: /trunk/src/org/openstreetmap/josm/gui/MapFrame.java =================================================================== --- /trunk/src/org/openstreetmap/josm/gui/MapFrame.java (revision 5908) +++ /trunk/src/org/openstreetmap/josm/gui/MapFrame.java (revision 5909) @@ -148,5 +148,5 @@ * Constructs a new {@code MapFrame}. * @param contentPane The content pane used to register shortcuts in its - * {@link InputMap} and {@link ActionMap} + * {@link javax.swing.InputMap} and {@link javax.swing.ActionMap} * @param viewportData the initial viewport of the map. Can be null, then * the viewport is derived from the layer data. @@ -338,4 +338,5 @@ /** * Fires an property changed event "visible". + * @param aFlag {@code true} if display should be visible */ @Override public void setVisible(boolean aFlag) { @@ -352,6 +353,6 @@ * if new map mode is correct mode for current layer and does not change mode * in such cases. - * @param mapMode The new mode to set. - * @return + * @param newMapMode The new mode to set. + * @return {@code true} if mode is really selected */ public boolean selectMapMode(MapMode newMapMode) { @@ -362,7 +363,7 @@ * Another version of the selectMapMode for changing layer action. * Pass newly selected layer to this method. - * @param newMapMode - * @param newLayer - * @return True if mode is really selected + * @param newMapMode The new mode to set. + * @param newLayer newly selected layer + * @return {@code true} if mode is really selected */ public boolean selectMapMode(MapMode newMapMode, Layer newLayer) { Index: /trunk/src/org/openstreetmap/josm/gui/MapStatus.java =================================================================== --- /trunk/src/org/openstreetmap/josm/gui/MapStatus.java (revision 5908) +++ /trunk/src/org/openstreetmap/josm/gui/MapStatus.java (revision 5909) @@ -411,6 +411,6 @@ * Call this with a set of primitives to cycle through them. Method * will automatically select the next item and update the map - * @param osms - * @param mouse modifiers + * @param osms primitives to cycle through + * @param mods modifiers (i.e. control keys) */ private final void popupCycleSelection(Collection osms, int mods) { @@ -452,5 +452,4 @@ /** * Tries to hide the given popup - * @param popup */ private final void popupHidePopup() { @@ -465,7 +464,8 @@ /** - * Tries to show the given popup, can be hidden using popupHideOldPopup + * Tries to show the given popup, can be hidden using {@link #popupHidePopup} * If an old popup exists, it will be automatically hidden - * @param popup + * @param newPopup popup to show + * @param lbls lables to show (see {@link #popupLabels}) */ private final void popupShowPopup(Popup newPopup, List lbls) { @@ -525,5 +525,5 @@ * given OsmPrimitive * @param osm The primitive to create the label for - * @return + * @return labels for info popup */ private final JLabel popupBuildPrimitiveLabels(final OsmPrimitive osm) {