diff gnv-artifacts/src/main/java/de/intevation/gnv/chart/HorizontalCrossProfileChart.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 9697675ede21
children b1f5f2a8840f
line wrap: on
line diff
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/chart/HorizontalCrossProfileChart.java	Tue Mar 23 14:11:51 2010 +0000
+++ b/gnv-artifacts/src/main/java/de/intevation/gnv/chart/HorizontalCrossProfileChart.java	Wed Mar 24 14:48:55 2010 +0000
@@ -12,13 +12,34 @@
 import org.jfree.data.general.Series;
 
 /**
- * @author Ingo Weinzierl <ingo.weinzierl@intevation.de>
+ * Implementation to create a special type of horizontal profile charts.
+ *
+ * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a>
  */
 public class HorizontalCrossProfileChart
 extends      HorizontalProfileChart
 {
+    /**
+     * Logger used for logging with log4j.
+     */
     private static Logger log = Logger.getLogger(HorizontalCrossProfileChart.class);
 
+    /**
+     * Constructor to create HorizontalCrossProfileChart objects.
+     *
+     * @param labels Labels used to be displayed in title, subtitle and so on.
+     * @param theme ChartTheme used to adjust the rendering of this chart.
+     * @param parameters Collection containing a bunch of parameters.
+     * @param measurements Collection containing a bunch of measurements.
+     * @param dates Collection containing a bunch of date objects.
+     * @param result Collection containing a bunch of <code>Result</code>
+     * objects which contain the actual data items to be displayed.
+     * @param timeGaps Collection with timegap definitions.
+     * @param locale Locale used to specify the format of labels, numbers, ...
+     * @param linesVisible Render lines between data points if true, otherwise
+     * not.
+     * @param shapesVisible Render vertices as points if true, otherwise not.
+     */
     public HorizontalCrossProfileChart(
         ChartLabels labels,
         ChartTheme  theme,
@@ -46,6 +67,13 @@
     }
 
 
+    /**
+     * Method for gap detection. Nothing is done here, because in this type of
+     * chart no gap detection takes place.
+     *
+     * @see de.intevation.gnv.chart.HorizontalProfileChart#gapDetection(Result[],
+     * Series, int, int)
+     */
     @Override
     protected void gapDetection(
         Result[] results,

http://dive4elements.wald.intevation.org