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

[Wald Commits]

# HG changeset patch
# User Felix Wolfsteller <felix.wolfsteller at intevation.de>
# Date 1363769474 -3600
# Node ID 5f38d1c39ebd264627489f966d4d228fd6ca7e57
# Parent  1b73b731f7bdb6702859d9fdfc4e46899aa1efa9
Doc.

diff -r 1b73b731f7bd -r 5f38d1c39ebd flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/DischargeTables.java
--- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/DischargeTables.java	Wed Mar 20 08:50:51 2013 +0100
+++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/DischargeTables.java	Wed Mar 20 09:51:14 2013 +0100
@@ -26,10 +26,10 @@
     /** Private logger. */
     private static Logger log = Logger.getLogger(DischargeTables.class);
 
-    /** Scale to convert discharge table values of master table into [cm] */
+    /** Scale to convert discharge table values of master table into [cm]. */
     public static final double MASTER_SCALE = 100d;
 
-    /** Scale to convert discharge table values of historical tables into [cm] */
+    /** Scale to convert discharge table values of historical tables into [cm]. */
     public static final double HISTORICAL_SCALE = 1d;
 
     public static final int MASTER = 0;
@@ -184,6 +184,11 @@
         return x > a && x < b;
     }
 
+    /**
+     * Find or interpolate Qs from q/w array.
+     * @param values [[q0,q1,q2],[w0,w1,w2]]
+     * @param w      W value to look for in values.
+     */
     public static double [] getQsForW(double [][] values, double w) {
 
         boolean debug = log.isDebugEnabled();