[Dive4elements-commits] [PATCH 1 of 2] Picky doc and whitespace fixes

[Wald Commits]

# HG changeset patch
# User Felix Wolfsteller <felix.wolfsteller at intevation.de>
# Date 1361878559 -3600
# Node ID a929d9a9fa1ee8c8130d45933111a894e351d1f9
# Parent  34baad34987f888de968c686c8be47b89679c410
Picky doc and whitespace fixes.

diff -r 34baad34987f -r a929d9a9fa1e flys-artifacts/src/main/java/de/intevation/flys/artifacts/CollectionMonitor.java
--- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/CollectionMonitor.java	Tue Feb 26 16:11:11 2013 +0100
+++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/CollectionMonitor.java	Tue Feb 26 12:35:59 2013 +0100
@@ -22,10 +22,12 @@
 
 import de.intevation.flys.artifacts.datacage.Recommendations;
 
+/** Monitors collection changes. */
 public class CollectionMonitor implements Hook {
 
     public static final String XPATH_RESULT = "/art:result";
 
+
     @Override
     public void setup(Node cfg) {
     }
diff -r 34baad34987f -r a929d9a9fa1e flys-artifacts/src/main/java/de/intevation/flys/artifacts/access/FixAccess.java
--- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/access/FixAccess.java	Tue Feb 26 16:11:11 2013 +0100
+++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/access/FixAccess.java	Tue Feb 26 12:35:59 2013 +0100
@@ -7,6 +7,7 @@
 
 import org.apache.log4j.Logger;
 
+/** Access for Fixation related data. */
 public class FixAccess
 extends      RangeAccess
 {
diff -r 34baad34987f -r a929d9a9fa1e flys-artifacts/src/main/java/de/intevation/flys/artifacts/access/FixRealizingAccess.java
--- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/access/FixRealizingAccess.java	Tue Feb 26 16:11:11 2013 +0100
+++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/access/FixRealizingAccess.java	Tue Feb 26 12:35:59 2013 +0100
@@ -9,6 +9,8 @@
 
 import org.apache.log4j.Logger;
 
+
+/** Fix-Realizing (Volmer/Ausgelagerte Wasserspiegellage) access. */
 public class FixRealizingAccess
 extends      FixAccess
 {
diff -r 34baad34987f -r a929d9a9fa1e flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/Segment.java
--- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/Segment.java	Tue Feb 26 16:11:11 2013 +0100
+++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/Segment.java	Tue Feb 26 12:35:59 2013 +0100
@@ -53,6 +53,7 @@
         return from < to;
     }
 
+    /** Checks whether given km lies inside the to/from bounds of this segment. */
     public boolean inside(double km) {
         return from < to
             ? km >= from && km <= to
@@ -120,6 +121,7 @@
         return referencePoint;
     }
 
+    /** Use DoubleUtil to parse Segments. */
     public static List<Segment> parseSegments(String input) {
 
         final List<Segment> segments = new ArrayList<Segment>();
diff -r 34baad34987f -r a929d9a9fa1e flys-artifacts/src/main/java/de/intevation/flys/artifacts/states/InputDoubleState.java
--- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/states/InputDoubleState.java	Tue Feb 26 16:11:11 2013 +0100
+++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/states/InputDoubleState.java	Tue Feb 26 12:35:59 2013 +0100
@@ -6,7 +6,7 @@
 
 
 /**
- * State to keep a double value and validate it against a range
+ * State to keep a double value and validate it against a range.
  */
 public class InputDoubleState extends MinMaxState {
 
diff -r 34baad34987f -r a929d9a9fa1e flys-artifacts/src/main/java/de/intevation/flys/artifacts/states/WQAdapted.java
--- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/states/WQAdapted.java	Tue Feb 26 16:11:11 2013 +0100
+++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/states/WQAdapted.java	Tue Feb 26 12:35:59 2013 +0100
@@ -59,6 +59,7 @@
     public static final GaugeOrder GAUGE_UP   = new GaugeOrder(true);
     public static final GaugeOrder GAUGE_DOWN = new GaugeOrder(false);
 
+
     /** Trivial, empty constructor. */
     public WQAdapted() {
     }
@@ -117,6 +118,7 @@
     }
 
 
+    /** Create the items for input to the ranges per mode. */
     protected Element[] createValueItems(
         XMLUtils.ElementCreator cr,
         Artifact    artifact,
diff -r 34baad34987f -r a929d9a9fa1e flys-artifacts/src/main/java/de/intevation/flys/exports/ATWriter.java
--- a/flys-artifacts/src/main/java/de/intevation/flys/exports/ATWriter.java	Tue Feb 26 16:11:11 2013 +0100
+++ b/flys-artifacts/src/main/java/de/intevation/flys/exports/ATWriter.java	Tue Feb 26 12:35:59 2013 +0100
@@ -25,6 +25,7 @@
 
 import org.apache.log4j.Logger;
 
+/** Write AT files. */
 public class ATWriter
 {
     private static Logger logger = Logger.getLogger(ATWriter.class);
@@ -156,7 +157,7 @@
     {
         PrintWriter out = new PrintWriter(writer);
 
-        // a header is required, because the desktop version of FLYS will skip
+        // A header is required, because the desktop version of FLYS will skip
         // the first row.
         if (gName != null) {
             printGaugeHeader(out, meta, river, km, gName, datum, date);
diff -r 34baad34987f -r a929d9a9fa1e flys-artifacts/src/main/java/de/intevation/flys/exports/WaterlevelExporter.java
--- a/flys-artifacts/src/main/java/de/intevation/flys/exports/WaterlevelExporter.java	Tue Feb 26 16:11:11 2013 +0100
+++ b/flys-artifacts/src/main/java/de/intevation/flys/exports/WaterlevelExporter.java	Tue Feb 26 12:35:59 2013 +0100
@@ -110,7 +110,6 @@
     public static final String CSV_NOT_IN_GAUGE_RANGE =
         "export.waterlevel.csv.not.in.gauge.range";
 
-
     public static final Pattern NUMBERS_PATTERN =
         Pattern.compile("\\D*(\\d++.\\d*)\\D*");