# HG changeset patch
# User Felix Wolfsteller <felix.wolfsteller@intevation.de>
# Date 1339007329 0
# Node ID d20215a0afd8e38d84028f7d60f34c47daef5ec0
# Parent  6e4ad35bcb1172cf3295b2999cef8d99afbf6a4a
Cosmetics, doc.

flys-artifacts/trunk@4616 c6561f87-3c4e-4783-a992-168aeb5c3f6f

diff -r 6e4ad35bcb11 -r d20215a0afd8 flys-artifacts/ChangeLog
--- a/flys-artifacts/ChangeLog	Wed Jun 06 15:48:59 2012 +0000
+++ b/flys-artifacts/ChangeLog	Wed Jun 06 18:28:49 2012 +0000
@@ -1,3 +1,10 @@
+2012-06-06	Felix Wolfsteller	<felix.wolfsteller@intevation.de>
+
+	* src/main/java/de/intevation/flys/artifacts/model/GaugeDischargeFacet.java,
+	  src/main/java/de/intevation/flys/artifacts/states/HistoricalDischargeComputeState.java,
+	  src/main/java/de/intevation/flys/utils/FLYSUtils.java:
+	  Cosmetics, doc.
+
 2012-06-06	Felix Wolfsteller	<felix.wolfsteller@intevation.de>
 
 	* src/main/java/de/intevation/flys/artifacts/GaugeDischargeArtifact.java:
diff -r 6e4ad35bcb11 -r d20215a0afd8 flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/GaugeDischargeFacet.java
--- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/GaugeDischargeFacet.java	Wed Jun 06 15:48:59 2012 +0000
+++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/GaugeDischargeFacet.java	Wed Jun 06 18:28:49 2012 +0000
@@ -16,6 +16,7 @@
  */
 public class GaugeDischargeFacet extends DataFacet {
 
+    /** Private logger. */
     private static final Logger logger =
         Logger.getLogger(GaugeDischargeFacet.class);
 
@@ -24,8 +25,14 @@
     }
 
 
+    /**
+     * @param index Index translates to index of WQ-array.
+     * @param name Name of the facet.
+     * @param desc Description of the facet (visible in client).
+     */
     public GaugeDischargeFacet(int index, String name, String desc) {
-        super(index, name, desc, ComputeType.ADVANCE, null, "state.gaugedischarge.init");
+        super(index, name, desc, ComputeType.ADVANCE, null,
+            "state.gaugedischarge.init");
     }
 
 
@@ -53,6 +60,9 @@
     }
 
 
+    /**
+     * @return wqkms corresponding to gauge of artifact and index of facet.
+     */
     @Override
     public Object getData(Artifact artifact, CallContext context) {
         if (logger.isDebugEnabled()) {
diff -r 6e4ad35bcb11 -r d20215a0afd8 flys-artifacts/src/main/java/de/intevation/flys/artifacts/states/HistoricalDischargeComputeState.java
--- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/states/HistoricalDischargeComputeState.java	Wed Jun 06 15:48:59 2012 +0000
+++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/states/HistoricalDischargeComputeState.java	Wed Jun 06 18:28:49 2012 +0000
@@ -26,6 +26,7 @@
 
 
 /**
+ * State to calculate historical discharge curves.
  * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a>
  */
 public class HistoricalDischargeComputeState
diff -r 6e4ad35bcb11 -r d20215a0afd8 flys-artifacts/src/main/java/de/intevation/flys/utils/FLYSUtils.java
--- a/flys-artifacts/src/main/java/de/intevation/flys/utils/FLYSUtils.java	Wed Jun 06 15:48:59 2012 +0000
+++ b/flys-artifacts/src/main/java/de/intevation/flys/utils/FLYSUtils.java	Wed Jun 06 18:28:49 2012 +0000
@@ -45,6 +45,8 @@
 import de.intevation.flys.model.MainValue;
 import de.intevation.flys.model.River;
 
+
+/** static helper methods to e.g. access FLYSArtifacts data. */
 public class FLYSUtils {
 
     /** The logger that is used in this utility. */