changeset 3044:37982acfe1a3

Documentation added. flys-artifacts/trunk@4613 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Felix Wolfsteller <felix.wolfsteller@intevation.de>
date Wed, 06 Jun 2012 15:44:59 +0000
parents 22da13d1b180
children 0905d1e7b37e
files flys-artifacts/ChangeLog flys-artifacts/src/main/java/de/intevation/flys/artifacts/StaticWKmsArtifact.java
diffstat 2 files changed, 9 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/flys-artifacts/ChangeLog	Wed Jun 06 14:58:25 2012 +0000
+++ b/flys-artifacts/ChangeLog	Wed Jun 06 15:44:59 2012 +0000
@@ -1,3 +1,8 @@
+2012-06-06	Felix Wolfsteller	<felix.wolfsteller@intevation.de>
+
+	* src/main/java/de/intevation/flys/artifacts/StaticWKmsArtifact.java:
+	  Doc.
+
 2012-06-06  Raimund Renkert <raimund.renkert@intevation.de>
 
 	Added facet for derivate curve and fixed facet names.
--- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/StaticWKmsArtifact.java	Wed Jun 06 14:58:25 2012 +0000
+++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/StaticWKmsArtifact.java	Wed Jun 06 15:44:59 2012 +0000
@@ -268,6 +268,9 @@
     /**
      * Returns W at Km of WKms, searching linearly.
      * Returns -1 if not found.
+     * @param wkms the WKms object to search for given km.
+     * @param km The searched km.
+     * @return W at given km if in WKms, -1 if not found.
      */
     public static double getWAtKm(WKms wkms, double km) {
         // Uninformed search.
@@ -286,7 +289,7 @@
      * Get points of line describing the surface of water at cross section.
      *
      * @return an array holding coordinates of points of surface of water (
-     *         in the form {{x1, x2} {y1, y2}} ).
+     *         in the form {{x1, x2}, {y1, y2}} ).
      */
     @Override
     public Lines.LineData getWaterLines(int idx, FastCrossSectionLine csl) {

http://dive4elements.wald.intevation.org