diff gnv-artifacts/src/main/java/de/intevation/gnv/math/Metrics.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 f953c9a559d8
line wrap: on
line diff
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/math/Metrics.java	Thu Apr 08 10:10:04 2010 +0000
+++ b/gnv-artifacts/src/main/java/de/intevation/gnv/math/Metrics.java	Thu Apr 08 11:31:44 2010 +0000
@@ -3,12 +3,28 @@
 import com.vividsolutions.jts.geom.Coordinate;
 
 /**
+ * Implementations provides the ability to calculate the distance between
+ * two points ans support for interpolating points between two points.
+ *
  * @author <a href="mailto:sascha.teichmann@intevation.de">Sascha L. Teichmann</a>
  */
 public interface Metrics
 {
+    /**
+     * Calculates the distance between two given points.
+     * @param p1 The first point.
+     * @param p2 The second point.
+     * @return The distance.
+     */
     double distance(Coordinate p1, Coordinate p2);
 
+    /**
+     * Return an interpolator which allows interpolations between
+     * two given points.
+     * @param p1 The first point.
+     * @param p2 The second point.
+     * @return The interpolator.
+     */
     Interpolator getInterpolator(Coordinate p1, Coordinate p2);
 }
 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :

http://dive4elements.wald.intevation.org