[Dive4elements-commits] [PATCH 1 of 3] Documentation added

[Wald Commits]

# HG changeset patch
# User Felix Wolfsteller <felix.wolfsteller at intevation.de>
# Date 1354181251 -3600
# Node ID afd817b006b7badef7f7e3e1e63244da96252fc6
# Parent  1243531f83ac730790d29f34f259fe7851684a94
Documentation added.

diff -r 1243531f83ac -r afd817b006b7 flys-artifacts/src/main/java/de/intevation/flys/artifacts/services/MetaDataService.java
--- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/services/MetaDataService.java	Wed Nov 28 11:29:04 2012 +0100
+++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/services/MetaDataService.java	Thu Nov 29 10:27:31 2012 +0100
@@ -104,6 +104,7 @@
         return data;
     }
 
+    /** Return the document containing matched stuff from meta-data.xml. */
     protected Document doService(
         String        artifactId,
         String        userId,
diff -r 1243531f83ac -r afd817b006b7 flys-artifacts/src/main/java/de/intevation/flys/exports/ChartGenerator.java
--- a/flys-artifacts/src/main/java/de/intevation/flys/exports/ChartGenerator.java	Wed Nov 28 11:29:04 2012 +0100
+++ b/flys-artifacts/src/main/java/de/intevation/flys/exports/ChartGenerator.java	Thu Nov 29 10:27:31 2012 +0100
@@ -495,6 +495,8 @@
     public abstract JFreeChart generateChart();
 
 
+    /** For every outable (i.e. facets), this function is
+     * called and handles the data accordingly. */
     @Override
     public abstract void doOut(
         ArtifactAndFacet bundle,
@@ -699,12 +701,14 @@
     }
 
 
+    /** Sets the master artifact. */
     @Override
     public void setMasterArtifact(Artifact master) {
         this.master = master;
     }
 
 
+    /** Sets the collection. */
     @Override
     public void setCollection(FLYSArtifactCollection collection) {
         this.collection = collection;
@@ -1384,10 +1388,21 @@
     }
 
 
+    /**
+     * Look up \param key in i18n dictionary.
+     * @param key key for which to find i18nd version.
+     * @param def default, returned if lookup failed.
+     * @return value found in i18n dictionary, \param def if no value found.
+     */
     protected String msg(String key, String def) {
         return Resources.getMsg(context.getMeta(), key, def);
     }
 
+    /**
+     * Look up \param key in i18n dictionary.
+     * @param key key for which to find i18nd version.
+     * @return value found in i18n dictionary, key itself if failed.
+     */
     protected String msg(String key) {
         return Resources.getMsg(context.getMeta(), key, key);
     }