diff gnv-artifacts/src/main/java/de/intevation/gnv/chart/Chart.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 f5a041000357
children 9a828e5a2390
line wrap: on
line diff
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/chart/Chart.java	Tue Mar 23 14:11:51 2010 +0000
+++ b/gnv-artifacts/src/main/java/de/intevation/gnv/chart/Chart.java	Wed Mar 24 14:48:55 2010 +0000
@@ -6,10 +6,19 @@
 
 
 /**
- * @author Ingo Weinzierl <ingo.weinzierl@intevation.de>
+ * The <code>Chart</code> interface should be implemented by each type of chart. 
+ * The class must implement a method <code>generateChart</code> which returns a 
+ * JFreeChart object.
+ *
+ * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a>
  */
 public interface Chart
 extends          Serializable
 {
+    /**
+     * This method is used to create a JFreeChart of this object.
+     *
+     * @return JFreeChart object.
+     */
     public JFreeChart generateChart();
 }

http://dive4elements.wald.intevation.org