diff gnv-artifacts/src/main/java/de/intevation/gnv/chart/ChartLabels.java @ 767:79401c871da4

Added and repaired javadoc in de.intevation.gnv.chart package. gnv-artifacts/trunk@823 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Ingo Weinzierl <ingo.weinzierl@intevation.de>
date Wed, 24 Mar 2010 14:48:55 +0000
parents 79e80c289018
children 3f447e92024a
line wrap: on
line diff
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/chart/ChartLabels.java	Tue Mar 23 14:11:51 2010 +0000
+++ b/gnv-artifacts/src/main/java/de/intevation/gnv/chart/ChartLabels.java	Wed Mar 24 14:48:55 2010 +0000
@@ -14,12 +14,12 @@
 
 /**
  * @author drewnak
- * @author Tim Englich <tim.englich@intevation.de> Changes and codecleanup
- * @author Ingo Weinzierl <ingo.weinzierl@intevation.de>
+ * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> Changes and codecleanup
+ * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a>
  */
 public class ChartLabels {
     /**
-     * 
+     *
      */
     private String title;
 
@@ -47,13 +47,22 @@
     /**
      * Constructor
      * 
-     * @param title
-     * @param domainAxisLabel
+     * @param title Title
+     * @param subtitle Subtitle
+     * @param domainAxisLabel X-axis label
      */
     public ChartLabels(String title, String subtitle, String domainAxisLabel) {
         this(title, subtitle, domainAxisLabel, null);
     }
 
+    /**
+     * Constructor
+     *
+     * @param title Title
+     * @param subtitle Subtitle
+     * @param domainAxisLabel X-axis label
+     * @param rangeAxisLabel Y-axis label
+     */
     public ChartLabels(
         String title,
         String subtitle,
@@ -64,6 +73,15 @@
     }
 
 
+    /**
+     * Constructor
+     *
+     * @param title Title
+     * @param subtitle Subtitle
+     * @param domainAxisLabel X-axis label
+     * @param rangeAxisLabel Y-axis label
+     * @param parameterName Name of a given parameter in the chart.
+     */
     public ChartLabels(
         String title,
         String subtitle,
@@ -101,11 +119,17 @@
     }
 
 
+    /**
+     * @return the y-axis label
+     */
     public String getRangeAxisLabel() {
         return this.rangeAxisLabel;
     }
 
 
+    /**
+     * @return the parameter name
+     */
     public String getParameterName() {
         return this.parameterName;
     }

http://dive4elements.wald.intevation.org