Skip to content

Commit 623be7c

Browse files
committed
fix javadoc warnings
1 parent 7851fd8 commit 623be7c

File tree

1 file changed

+22
-21
lines changed

1 file changed

+22
-21
lines changed

src/org/openstreetmap/josm/plugins/rex/actions/TagRoundaboutAction.java

Lines changed: 22 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -151,11 +151,11 @@ public void actionPerformed(ActionEvent e) {
151151
/**
152152
* Tag node as roundabout
153153
*
154-
* @TODO direction as well?
155-
*
156154
* This method is overloaded with (Way circle)
155+
* @param node node
157156
*/
158157
public void tagAsRoundabout(Node node) {
158+
// TODO direction as well?
159159
Main.main.undoRedo.add(new ChangePropertyCommand(node, "junction", "roundabout"));
160160
Main.main.undoRedo.add(new ChangePropertyCommand(node, "highway", "mini_roundabout"));
161161
int d = Main.pref.getInt("rex.diameter_meter", 12);
@@ -166,6 +166,7 @@ public void tagAsRoundabout(Node node) {
166166
* Tag closed way as roundabout
167167
*
168168
* This method is overloaded with (Node node)
169+
* @param circle way
169170
*/
170171
public void tagAsRoundabout(Way circle) {
171172
DataSet ds = circle.getDataSet();
@@ -194,10 +195,10 @@ public void tagAsRoundabout(Way circle) {
194195
/**
195196
* Create a roundabout way
196197
*
197-
* @param Node node Node to expand to Roundabout
198-
* @param double radi Radius of roundabout in meter
199-
* @param boolean lefthandtraffic Direction of roundabout
200-
* @param double max_gap Max gap in radians between nodes to make it pretty
198+
* @param node Node to expand to Roundabout
199+
* @param radi Radius of roundabout in meter
200+
* @param lefthandtraffic Direction of roundabout
201+
* @param max_gap Max gap in radians between nodes to make it pretty
201202
*/
202203
public void makeRoundabout(Node node, double radi, boolean lefthandtraffic, double max_gap) {
203204
//Store center for later use
@@ -396,9 +397,9 @@ private Way modifyWay(Node originalNode, Way originalWay, List<Node> newNodes) {
396397
/**
397398
* Sort nodes angular in relation to center
398399
*
399-
* @param List<Node> nodes
400-
* @param Node center
401-
* @param boolean clockwise
400+
* @param nodes nodes
401+
* @param center center
402+
* @param clockwise clockwise?
402403
*/
403404
private void angularSort(List<Node> nodes, LatLon center, boolean clockwise) {
404405
Collections.sort(nodes, new AngComp(center));
@@ -501,8 +502,8 @@ public int compare(Way a, Way b) {
501502
* Move a node it distance meter in the heading of
502503
* the next node in the way it is the last node in.
503504
*
504-
* @param Node node Node to be moved
505-
* @param double distance Distance to move node in meter
505+
* @param node Node to be moved
506+
* @param distance Distance to move node in meter
506507
*/
507508
public boolean moveWayEndNodeTowardsNextNode(Node node, double distance) {
508509
//some verification:
@@ -522,9 +523,9 @@ public boolean moveWayEndNodeTowardsNextNode(Node node, double distance) {
522523
* Move a node it distance meter in the heading of
523524
* the next node in the way it is the last node in.
524525
*
525-
* @param Node node Node to be moved
526-
* @param double distance Distance to move node in meter
527-
* @param Way way Way
526+
* @param node Node to be moved
527+
* @param distance Distance to move node in meter
528+
* @param way Way
528529
*/
529530
public boolean moveWayEndNodeTowardsNextNode(Node node, double distance, Way way) {
530531
//Node must be first or last node in way
@@ -553,9 +554,9 @@ public boolean moveWayEndNodeTowardsNextNode(Node node, double distance, Way way
553554
/**
554555
* Return a LatLon moved distance meter in heading from start
555556
*
556-
* @param LatLon start point
557-
* @param double heading in radians
558-
* @param double distance in Meter
557+
* @param start point
558+
* @param heading in radians
559+
* @param distance in Meter
559560
*
560561
* @return LatLon New position
561562
*/
@@ -577,7 +578,7 @@ private LatLon moveHeadingDistance(LatLon start, double heading, double distance
577578
/**
578579
* Output a message
579580
*
580-
* @param String Message
581+
* @param str Message
581582
*/
582583
public void pri(String str) {
583584
Notification t = new Notification(str);
@@ -700,9 +701,9 @@ private boolean wayContainsAllNodes(Way way, List<Node> nodes) {
700701
}
701702

702703
/**
703-
* @param Way iWay incoming way
704-
* @param Way tWay across way
705-
* @param Node cNode common node
704+
* @param iWay incoming way
705+
* @param tWay across way
706+
* @param cNode common node
706707
*
707708
* @return boolean Success
708709
*/

0 commit comments

Comments
 (0)