diff gnv-artifacts/src/main/java/de/intevation/gnv/math/LinearMetrics.java @ 805:bb7afd783321

Removed trailing whitespace. Added more javadoc. gnv-artifacts/trunk@887 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Sascha L. Teichmann <sascha.teichmann@intevation.de>
date Thu, 08 Apr 2010 11:31:44 +0000
parents 6cff63d0c434
children 05bf8534a35a
line wrap: on
line diff
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/math/LinearMetrics.java	Thu Apr 08 10:10:04 2010 +0000
+++ b/gnv-artifacts/src/main/java/de/intevation/gnv/math/LinearMetrics.java	Thu Apr 08 11:31:44 2010 +0000
@@ -3,14 +3,22 @@
 import com.vividsolutions.jts.geom.Coordinate;
 
 /**
+ * Implements {@link de.intevation.gnv.math.Metrics}
+ * for linear interpolations and distance measurements.
  * @author <a href="mailto:sascha.teichmann@intevation.de">Sascha L. Teichmann</a>
  */
 public final class LinearMetrics
 implements         Metrics
 {
+    /**
+     * Instance to prevent needless creations of instances.
+     */
     public static final Metrics INSTANCE =
         new LinearMetrics();
 
+    /**
+     * Implements the corresponding linear interpolator.
+     */
     public static final class LinearInterpolator
     implements                Interpolator
     {
@@ -19,6 +27,12 @@
         private double my;
         private double by;
 
+        /**
+         * Constructor to create a linear interpolator between two
+         * given points.
+         * @param p1 The first point.
+         * @param p2 The second point.
+         */
         public LinearInterpolator(Coordinate p1, Coordinate p2) {
 
             /*
@@ -56,4 +70,4 @@
         return new LinearInterpolator(p1, p2);
     }
 }
-// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :
+// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :
\ No newline at end of file

http://dive4elements.wald.intevation.org