# HG changeset patch
# User Felix Wolfsteller <felix.wolfsteller@intevation.de>
# Date 1349682663 -7200
# Node ID 6d8c7a00e74eb6541ea51a0ed5e7f501ef4c5515
# Parent  58bdf95df5e4abde31bcbab67e4cf3ee636fd0dd
Do cumentation.

diff -r 58bdf95df5e4 -r 6d8c7a00e74e flys-artifacts/ChangeLog
--- a/flys-artifacts/ChangeLog	Sat Oct 06 13:19:44 2012 +0200
+++ b/flys-artifacts/ChangeLog	Mon Oct 08 09:51:03 2012 +0200
@@ -1,3 +1,19 @@
+2012-10-08	Felix Wolfsteller	<felix.wolfsteller@intevation.de>
+
+	* flys-artifacts/src/main/java/de/intevation/flys/artifacts/access/ExtremeAccess.java,
+	  flys-artifacts/src/main/java/de/intevation/flys/artifacts/charts/TimeseriesStepChart.java,
+	  flys-artifacts/src/main/java/de/intevation/flys/utils/DoubleUtil.java:
+	  Doc.
+
+2012-10-05	Felix Wolfsteller	<felix.wolfsteller@intevation.de>
+
+	* flys-artifacts/src/main/java/de/intevation/flys/artifacts/states/CalculationSelect.java,
+	  flys-artifacts/src/main/java/de/intevation/flys/artifacts/states/LocationDistanceSelect.java,
+	  flys-artifacts/src/main/java/de/intevation/flys/artifacts/states/extreme/ExtremeCompute.java,
+	  flys-artifacts/src/main/java/de/intevation/flys/artifacts/states/fixation/FunctionSelect.java,
+	  flys-artifacts/src/main/java/de/intevation/flys/artifacts/transitions/ValueCompareTransition.java:
+	  Cosmetics, docs.
+
 2012-10-06	Sascha L. Teichmann	<sascha.teichmann@intevation.de>
 
 	* src/main/java/de/intevation/flys/artifacts/CollectionMonitor.java,
diff -r 58bdf95df5e4 -r 6d8c7a00e74e flys-artifacts/src/main/java/de/intevation/flys/artifacts/access/ExtremeAccess.java
--- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/access/ExtremeAccess.java	Sat Oct 06 13:19:44 2012 +0200
+++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/access/ExtremeAccess.java	Mon Oct 08 09:51:03 2012 +0200
@@ -30,6 +30,7 @@
 
     protected List<RangeWithValues> ranges;
 
+
     public ExtremeAccess() {
     }
 
@@ -37,6 +38,8 @@
         super(artifact);
     }
 
+
+    /** From (km) for calculation. */
     public Double getFrom() {
 
         if (from == null) {
@@ -50,6 +53,8 @@
         return from;
     }
 
+
+    /** To (km) for calculation. */
     public Double getTo() {
 
         if (to == null) {
@@ -63,6 +68,8 @@
         return to;
     }
 
+
+    /** Step width for calculation. */
     public Double getStep() {
 
         if (step == null) {
diff -r 58bdf95df5e4 -r 6d8c7a00e74e flys-artifacts/src/main/java/de/intevation/flys/artifacts/charts/TimeseriesStepChart.java
--- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/charts/TimeseriesStepChart.java	Sat Oct 06 13:19:44 2012 +0200
+++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/charts/TimeseriesStepChart.java	Mon Oct 08 09:51:03 2012 +0200
@@ -53,6 +53,7 @@
     }
 
 
+    /** Setup the log4j logging (read LOG4J_PROPERIES envvar). */
     public static void configureLogging() {
         String log4jProperties = System.getenv(LOG4J_PROPERTIES);
 
diff -r 58bdf95df5e4 -r 6d8c7a00e74e flys-artifacts/src/main/java/de/intevation/flys/utils/DoubleUtil.java
--- a/flys-artifacts/src/main/java/de/intevation/flys/utils/DoubleUtil.java	Sat Oct 06 13:19:44 2012 +0200
+++ b/flys-artifacts/src/main/java/de/intevation/flys/utils/DoubleUtil.java	Mon Oct 08 09:51:03 2012 +0200
@@ -8,8 +8,10 @@
 
 import org.apache.log4j.Logger;
 
+/** Utils to deal with Double precision values. */
 public class DoubleUtil
 {
+    /** Private logger. */
     private static Logger log = Logger.getLogger(DoubleUtil.class);
 
     public static final double DEFAULT_STEP_PRECISION = 1e6;
@@ -144,10 +146,15 @@
         return result;
     }
 
+
+    /** Use with parseSegments. */
     public interface SegmentCallback {
         void newSegment(double from, double to, double [] values);
     }
 
+
+    /** Call callback for every string split by colon.
+     * Expected format FROM:TO:VALUE1,VALUE2,VALUE3*/
     public static final void parseSegments(
         String          input,
         SegmentCallback callback