# HG changeset patch
# User Felix Wolfsteller <felix.wolfsteller@intevation.de>
# Date 1318232850 0
# Node ID 17648043429f382e687353df78c2f777deef36d1
# Parent  0053a4529f2f7277fd5e89c1d01dd8df3e2ae9f0
Cosmetics, docs, annotations.

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

diff -r 0053a4529f2f -r 17648043429f flys-artifacts/ChangeLog
--- a/flys-artifacts/ChangeLog	Mon Oct 10 07:31:23 2011 +0000
+++ b/flys-artifacts/ChangeLog	Mon Oct 10 07:47:30 2011 +0000
@@ -1,3 +1,16 @@
+2011-10-10  Felix Wolfsteller <felix.wolfsteller@intevation.de>
+
+	* src/main/java/de/intevation/flys/artifacts/math/DifferenceCurveFacet.java:
+	  Cosmetics, added an (@Override) annotation.
+
+	* src/main/java/de/intevation/flys/artifacts/model/CalculationResult.java,
+	  src/main/java/de/intevation/flys/artifacts/states/DefaultState.java:
+	  Cosmetics, added documentation.
+
+	* src/main/java/de/intevation/flys/artifacts/states/WQSelect.java:
+	  Cosmetics, whitespace after full stops in comments, added
+	  (@Override) annotation.
+
 2011-10-10  Ingo Weinzierl <ingo@intevation.de>
 
 	flys/issue220 (Diagramm: Achsenbeschriftungen an verschiedenen Achsen müssen gleich aussehen)
diff -r 0053a4529f2f -r 17648043429f flys-artifacts/src/main/java/de/intevation/flys/artifacts/math/DifferenceCurveFacet.java
--- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/math/DifferenceCurveFacet.java	Mon Oct 10 07:31:23 2011 +0000
+++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/math/DifferenceCurveFacet.java	Mon Oct 10 07:47:30 2011 +0000
@@ -38,6 +38,7 @@
      * Get difference curve data.
      * @return a WKms at given index.
      */
+    @Override
     public Object getData(Artifact artifact, CallContext context) {
         WINFOArtifact winfo = (WINFOArtifact)artifact;
 
diff -r 0053a4529f2f -r 17648043429f flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/CalculationResult.java
--- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/CalculationResult.java	Mon Oct 10 07:31:23 2011 +0000
+++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/CalculationResult.java	Mon Oct 10 07:47:30 2011 +0000
@@ -2,6 +2,9 @@
 
 import java.io.Serializable;
 
+/**
+ * Wraps result(s) of a Calculation and eventual error reports.
+ */
 public class CalculationResult
 implements   Serializable
 {
@@ -11,6 +14,9 @@
     public CalculationResult() {
     }
 
+    /**
+     * @param report report (e.g. error messages).
+     */
     public CalculationResult(Object data, Calculation report) {
         this.data   = data;
         this.report = report;
diff -r 0053a4529f2f -r 17648043429f flys-artifacts/src/main/java/de/intevation/flys/artifacts/states/DefaultState.java
--- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/states/DefaultState.java	Mon Oct 10 07:31:23 2011 +0000
+++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/states/DefaultState.java	Mon Oct 10 07:47:30 2011 +0000
@@ -349,6 +349,9 @@
     }
 
 
+    /**
+     * Returns which UIProvider shall be used to aid user input.
+     */
     protected String getUIProvider() {
         return null;
     }
diff -r 0053a4529f2f -r 17648043429f flys-artifacts/src/main/java/de/intevation/flys/artifacts/states/WQSelect.java
--- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/states/WQSelect.java	Mon Oct 10 07:31:23 2011 +0000
+++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/states/WQSelect.java	Mon Oct 10 07:47:30 2011 +0000
@@ -31,20 +31,20 @@
  */
 public class WQSelect extends DefaultState {
 
-    /** The logger used in this class.*/
+    /** The logger used in this class. */
     private static Logger logger = Logger.getLogger(WQSelect.class);
 
 
-    /** The default step width for Qs.*/
+    /** The default step width for Qs. */
     public static final String DEFAULT_STEP_Q = "50";
 
-    /** The default step width for Qs.*/
+    /** The default step width for Qs. */
     public static final String DEFAULT_STEP_W = "30";
 
     /** The name of the 'mode' field. */
     public static final String WQ_MODE = "wq_mode";
 
-    /** The name of the 'selection' field.*/
+    /** The name of the 'selection' field. */
     public static final String WQ_SELECTION = "wq_selection";
 
     /** The name of the 'from' field. */
@@ -66,6 +66,8 @@
     public WQSelect() {
     }
 
+    
+    @Override
     protected Element createData(
         XMLUtils.ElementCreator cr,
         Artifact    artifact,