[Dive4elements-commits] [PATCH 3 of 5] Documentation

[Wald Commits]

# HG changeset patch
# User Felix Wolfsteller <felix.wolfsteller at intevation.de>
# Date 1352985783 -3600
# Node ID cbd0fafcb26b559bb55da9c6d52c65cbd2077ea2
# Parent  06c10ad392807e9834982a2f42b7a4d913efadbc
Documentation.

diff -r 06c10ad39280 -r cbd0fafcb26b flys-artifacts/src/main/java/de/intevation/flys/artifacts/access/Access.java
--- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/access/Access.java	Thu Nov 15 14:22:12 2012 +0100
+++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/access/Access.java	Thu Nov 15 14:23:03 2012 +0100
@@ -37,6 +37,8 @@
         this.artifact = artifact;
     }
 
+
+    /** Get a data entry as string. */
     protected String getString(String key) {
         StateData sd = artifact.getData(key);
         if (sd == null) {
@@ -46,6 +48,7 @@
         return (String)sd.getValue();
     }
 
+    /** Get a data entry as double, returns null if string not double valueoffable. */
     protected Double getDouble(String key) {
         StateData sd = artifact.getData(key);
         if (sd == null) {
diff -r 06c10ad39280 -r cbd0fafcb26b flys-artifacts/src/main/java/de/intevation/flys/artifacts/access/BedDifferencesAccess.java
--- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/access/BedDifferencesAccess.java	Thu Nov 15 14:22:12 2012 +0100
+++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/access/BedDifferencesAccess.java	Thu Nov 15 14:23:03 2012 +0100
@@ -50,3 +50,4 @@
         return a.getInteger("height_id");
     }
 }
+// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :
diff -r 06c10ad39280 -r cbd0fafcb26b flys-artifacts/src/main/java/de/intevation/flys/artifacts/datacage/Recommendations.java
--- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/datacage/Recommendations.java	Thu Nov 15 14:22:12 2012 +0100
+++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/datacage/Recommendations.java	Thu Nov 15 14:23:03 2012 +0100
@@ -135,6 +135,11 @@
         }
     }
 
+
+    /**
+     * Put Key/Values from \param src to \param dst, but uppercase
+     * both Keys and Values.
+     */
     public static void convertKeysToUpperCase(
         Map<String, Object> src,
         Map<String, Object> dst
@@ -147,6 +152,7 @@
 
     /**
      * Append recommendations to \param result.
+     * @param extraParameters parameters (typicall example: 'recommended')
      */
     public void  recommend(
         FLYSArtifact        artifact,