[Dive4elements-commits] [PATCH 3 of 4] Doc, cosmetics

[Wald Commits]

# HG changeset patch
# User Felix Wolfsteller <felix.wolfsteller at intevation.de>
# Date 1363778725 -3600
# Node ID 61f4d4164a30d46999cf101a7e33e9970f4fd5d3
# Parent  7b119fa1e29f73ba80c68c446eb3fda8a1d32e2e
Doc, cosmetics.

diff -r 7b119fa1e29f -r 61f4d4164a30 flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/FixingsOverview.java
--- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/FixingsOverview.java	Wed Mar 20 11:42:10 2013 +0100
+++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/FixingsOverview.java	Wed Mar 20 12:25:25 2013 +0100
@@ -20,6 +20,8 @@
 import org.w3c.dom.Document;
 import org.w3c.dom.Element;
 
+
+/** Generate Fixings Table chart. */
 public class FixingsOverview
 implements   Serializable
 {
diff -r 7b119fa1e29f -r 61f4d4164a30 flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/GaugeFinder.java
--- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/GaugeFinder.java	Wed Mar 20 11:42:10 2013 +0100
+++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/GaugeFinder.java	Wed Mar 20 12:25:25 2013 +0100
@@ -11,7 +11,7 @@
 
 import org.hibernate.type.StandardBasicTypes;
 
-/** Find Gauges and respective main values. */
+/** Find Gauges and respective Q main values. */
 public class GaugeFinder
 implements   Serializable
 {
diff -r 7b119fa1e29f -r 61f4d4164a30 flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/GaugeFinderFactory.java
--- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/GaugeFinderFactory.java	Wed Mar 20 11:42:10 2013 +0100
+++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/GaugeFinderFactory.java	Wed Mar 20 12:25:25 2013 +0100
@@ -19,6 +19,7 @@
 
 import org.hibernate.type.StandardBasicTypes;
 
+/** Get GaugeFinders. */
 public class GaugeFinderFactory
 {
     private static Logger log = Logger.getLogger(GaugeFinderFactory.class);
diff -r 7b119fa1e29f -r 61f4d4164a30 flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/GaugeRange.java
--- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/GaugeRange.java	Wed Mar 20 11:42:10 2013 +0100
+++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/GaugeRange.java	Wed Mar 20 12:25:25 2013 +0100
@@ -32,16 +32,21 @@
 
     protected int gaugeId;
 
+    /** Certain main value. */
     protected Map<String, Double> mainValues;
+
     protected List<Sector> sectors;
 
+
     public GaugeRange() {
     }
 
+
     public GaugeRange(double start, double end, int gaugeId) {
         this(start, end, null, gaugeId);
     }
 
+
     public GaugeRange(
         double start,
         double end,
@@ -55,6 +60,7 @@
         sectors = new ArrayList<Sector>(3);
     }
 
+
     public void addMainValue(String label, Double value) {
         int idx = label.indexOf('(');
         if (idx >= 0) {
@@ -63,6 +69,7 @@
         mainValues.put(label, value);
     }
 
+
     protected Double getMainValue(String label) {
         Double v = mainValues.get(label);
         if (v == null) {
@@ -92,6 +99,7 @@
         }
     }
 
+
     public double getSectorBorder(int sector) {
         for (Sector s: sectors) {
             if (s.sector == sector) {
@@ -101,6 +109,7 @@
         return Double.NaN;
     }
 
+
     public int classify(double value) {
         for (Sector sector: sectors) {
             if (value < sector.value) {
@@ -110,14 +119,17 @@
         return sectors.size();
     }
 
+
     public String getName() {
         return name;
     }
 
+
     public void setName(String name) {
         this.name = name;
     }
 
+
     public String toString() {
         StringBuilder sb = new StringBuilder("sectors: [");
 
diff -r 7b119fa1e29f -r 61f4d4164a30 flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/HistoricalDischargeDifferenceFacet.java
--- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/HistoricalDischargeDifferenceFacet.java	Wed Mar 20 11:42:10 2013 +0100
+++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/HistoricalDischargeDifferenceFacet.java	Wed Mar 20 12:25:25 2013 +0100
@@ -10,6 +10,7 @@
 
 
 /**
+ * Difference of historical discharge curve to ...
  * @author <a href="mailto:ingo.weinzierl at intevation.de">Ingo Weinzierl</a>
  */
 public class HistoricalDischargeDifferenceFacet
diff -r 7b119fa1e29f -r 61f4d4164a30 flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/HistoricalWQTimerange.java
--- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/HistoricalWQTimerange.java	Wed Mar 20 11:42:10 2013 +0100
+++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/HistoricalWQTimerange.java	Wed Mar 20 12:25:25 2013 +0100
@@ -9,7 +9,7 @@
 
 /**
  * A subclass of WQTimerange that stores besides W, Q and Timerange values
- * another double value.
+ * another double value (difference to something).
  *
  * @author <a href="mailto:ingo.weinzierl at intevation.de">Ingo Weinzierl</a>
  */
diff -r 7b119fa1e29f -r 61f4d4164a30 flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/WQTimerange.java
--- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/WQTimerange.java	Wed Mar 20 11:42:10 2013 +0100
+++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/WQTimerange.java	Wed Mar 20 12:25:25 2013 +0100
@@ -6,10 +6,12 @@
 
 
 /**
+ * A collection of triples W,Q,Timerange.
  * @author <a href="mailto:ingo.weinzierl at intevation.de">Ingo Weinzierl</a>
  */
 public class WQTimerange extends WQ {
 
+    /** Used to sort <w,q,timerange> triples. */
     public static class TimerangeItem implements Comparable<TimerangeItem> {
         public double q;
         public double w;
diff -r 7b119fa1e29f -r 61f4d4164a30 flys-artifacts/src/main/java/de/intevation/flys/artifacts/services/AbstractChartService.java
--- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/services/AbstractChartService.java	Wed Mar 20 11:42:10 2013 +0100
+++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/services/AbstractChartService.java	Wed Mar 20 12:25:25 2013 +0100
@@ -19,7 +19,7 @@
 import de.intevation.artifacts.GlobalContext;
 import de.intevation.artifacts.Service;
 
-
+/** Serve chart. */
 public abstract class AbstractChartService extends DefaultService {
 
     public static final int DEFAULT_WIDTH = 240;