changeset 7532:aeeabb580b12

Doc.
author Felix Wolfsteller <felix.wolfsteller@intevation.de>
date Thu, 07 Nov 2013 09:44:38 +0100
parents 7302d2af815f
children 20b1cfa1e005
files artifacts/src/main/java/org/dive4elements/river/artifacts/model/minfo/SedimentLoadCalculation.java
diffstat 1 files changed, 6 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/artifacts/src/main/java/org/dive4elements/river/artifacts/model/minfo/SedimentLoadCalculation.java	Thu Nov 07 09:43:44 2013 +0100
+++ b/artifacts/src/main/java/org/dive4elements/river/artifacts/model/minfo/SedimentLoadCalculation.java	Thu Nov 07 09:44:38 2013 +0100
@@ -35,7 +35,8 @@
     protected double kmUp;
     protected double kmLow;
     protected int[] period;
-    /** Years of chosen epochs. */
+    /** Years of chosen epochs.
+     * epoch[0][0] is the start year of first entered epoch, e[0][1] the end-year. */
     protected int[][] epoch;
     protected String unit;
 
@@ -213,7 +214,10 @@
         }
     }
 
-    /** Calculate result for an epoch. */
+    /**
+     * Calculate result for the ith given epoch.
+     * @param i index of epoch (if multiple given).
+     */
     private SedimentLoadResult calculateEpoch(int i) {
         List<SedimentLoad> epochLoads = new ArrayList<SedimentLoad>();
         for (int j = epoch[i][0]; j < epoch[i][1]; j++) {

http://dive4elements.wald.intevation.org