[Dive4elements-commits] [PATCH 1 of 2] Doc fixes

[Wald Commits]

# HG changeset patch
# User Felix Wolfsteller <felix.wolfsteller at intevation.de>
# Date 1362127903 -3600
# Node ID 345f3bba6f15e8762bb7418087fc94abbf46f17a
# Parent  3b58bb0c55e3813c7ca7fa35b9d74c3385948570
Doc fixes.

diff -r 3b58bb0c55e3 -r 345f3bba6f15 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	Fri Mar 01 09:28:43 2013 +0100
+++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/Segment.java	Fri Mar 01 09:51:43 2013 +0100
@@ -15,6 +15,7 @@
 
 import org.apache.log4j.Logger;
 
+/** A Range with values and a reference point. */
 public class Segment
 implements   Serializable
 {
diff -r 3b58bb0c55e3 -r 345f3bba6f15 flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/fixings/FixCalculation.java
--- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/fixings/FixCalculation.java	Fri Mar 01 09:28:43 2013 +0100
+++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/fixings/FixCalculation.java	Fri Mar 01 09:51:43 2013 +0100
@@ -32,6 +32,7 @@
 
 import org.apache.log4j.Logger;
 
+/** Calculation base class for fix. */
 public abstract class FixCalculation
 extends               Calculation
 {
diff -r 3b58bb0c55e3 -r 345f3bba6f15 flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/fixings/FixRealizingCalculation.java
--- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/fixings/FixRealizingCalculation.java	Fri Mar 01 09:28:43 2013 +0100
+++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/fixings/FixRealizingCalculation.java	Fri Mar 01 09:51:43 2013 +0100
@@ -17,6 +17,7 @@
 
 import org.apache.log4j.Logger;
 
+/** Calculation for FixRealize (german: ausgel. WSPL). */
 public class FixRealizingCalculation
 extends      FixCalculation
 {
@@ -128,7 +129,7 @@
             }
         }
 
-        // name the curves
+        // Name the curves.
         for (int i = 0; i < results.length; ++i) {
             results[i].setName(createName(i));
         }
diff -r 3b58bb0c55e3 -r 345f3bba6f15 flys-artifacts/src/main/java/de/intevation/flys/collections/AttributeWriter.java
--- a/flys-artifacts/src/main/java/de/intevation/flys/collections/AttributeWriter.java	Fri Mar 01 09:28:43 2013 +0100
+++ b/flys-artifacts/src/main/java/de/intevation/flys/collections/AttributeWriter.java	Fri Mar 01 09:51:43 2013 +0100
@@ -164,7 +164,7 @@
     throws ArtifactDatabaseException
     {
         if (compatibleFacets == null) {
-            logger.warn("No compatible facets, not generating out.");
+            logger.warn("No compatible facets, not generating out " + outputName + ".");
             return false;
         }
 
diff -r 3b58bb0c55e3 -r 345f3bba6f15 flys-artifacts/src/main/java/de/intevation/flys/utils/DoubleUtil.java
--- a/flys-artifacts/src/main/java/de/intevation/flys/utils/DoubleUtil.java	Fri Mar 01 09:28:43 2013 +0100
+++ b/flys-artifacts/src/main/java/de/intevation/flys/utils/DoubleUtil.java	Fri Mar 01 09:51:43 2013 +0100
@@ -31,6 +31,10 @@
         return Math.round(x * DEFAULT_STEP_PRECISION)/DEFAULT_STEP_PRECISION;
     }
 
+    /**
+     * Returns array with values from parameter from to to with given step width.
+     * from and to are included.
+     */
     public static final double [] explode(
         double from,
         double to,