Changeset 5909 in josm for trunk/src/org/openstreetmap/josm/data/validation/tests/PowerLines.java

Timestamp:

2013-04-29T00:09:53+02:00 (12 years ago)

Author:

stoecker

Message:

fix all remaining javadoc warnings

File:

• trunk/src/org/openstreetmap/josm/data/validation/tests/PowerLines.java (modified) (5 diffs)

trunk/src/org/openstreetmap/josm/data/validation/tests/PowerLines.java

@@ -137 +137 @@
      * 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 +145 @@
     /**
      * 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 +154 @@
     /**
      * 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 +163 @@
     /**
      * 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 +170 @@
     }
     
+    /**
+     * 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<String> values) {
         String v = p.get("power");