diff gnv-artifacts/src/main/java/de/intevation/gnv/math/ConstantFunction.java @ 807:a645bd23c1c8

Added more javadoc. Removed trailing whitespace. gnv-artifacts/trunk@889 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Sascha L. Teichmann <sascha.teichmann@intevation.de>
date Thu, 08 Apr 2010 15:24:45 +0000
parents 6cff63d0c434
children f953c9a559d8
line wrap: on
line diff
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/math/ConstantFunction.java	Thu Apr 08 13:10:39 2010 +0000
+++ b/gnv-artifacts/src/main/java/de/intevation/gnv/math/ConstantFunction.java	Thu Apr 08 15:24:45 2010 +0000
@@ -3,16 +3,29 @@
 import org.apache.commons.math.analysis.UnivariateRealFunction;
 
 /**
+ * Models a constant function to be used in function evaluation.
+ *
  * @author <a href="mailto:sascha.teichmann@intevation.de">Sascha L. Teichmann</a>
  */
 public class ConstantFunction
 implements   UnivariateRealFunction
 {
+    /**
+     * The constant value.
+     */
     protected double value;
 
+    /**
+     * Defaut constructor.
+     */
     public ConstantFunction() {
     }
 
+    /**
+     * Constructor to create a ConstantFunction with
+     * a given constant value.
+     * @param value The constant value.
+     */
     public ConstantFunction(double value) {
         this.value = value;
     }

http://dive4elements.wald.intevation.org