changeset 794:d0967fdee36f

Repaired JavaDoc in Export package. gnv-artifacts/trunk@876 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Ingo Weinzierl <ingo.weinzierl@intevation.de>
date Wed, 31 Mar 2010 12:18:03 +0000
parents 2047f318e964
children cdade5005cba
files gnv-artifacts/ChangeLog gnv-artifacts/src/main/java/de/intevation/gnv/exports/ChartExportHelper.java gnv-artifacts/src/main/java/de/intevation/gnv/exports/Export.java gnv-artifacts/src/main/java/de/intevation/gnv/exports/ODVExport.java
diffstat 4 files changed, 18 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/gnv-artifacts/ChangeLog	Wed Mar 31 10:56:39 2010 +0000
+++ b/gnv-artifacts/ChangeLog	Wed Mar 31 12:18:03 2010 +0000
@@ -1,3 +1,9 @@
+2010-03-31  Ingo Weinzierl <ingo.weinzierl@intevation.de>
+
+	* src/main/java/de/intevation/gnv/exports/Export.java,
+	  src/main/java/de/intevation/gnv/exports/ChartExportHelper.java,
+	  src/main/java/de/intevation/gnv/exports/ODVExport.java: Repaired JavaDoc.
+
 2010-03-31  Ingo Weinzierl <ingo.weinzierl@intevation.de>
 
 	* src/main/java/de/intevation/gnv/chart/Chart.java,
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/exports/ChartExportHelper.java	Wed Mar 31 10:56:39 2010 +0000
+++ b/gnv-artifacts/src/main/java/de/intevation/gnv/exports/ChartExportHelper.java	Wed Mar 31 12:18:03 2010 +0000
@@ -65,7 +65,7 @@
      * <code>OutputStream</code> with a given format, width and height.
      *
      * @param out OutputStream
-     * @param JFreeChart Chart to be exported
+     * @param chart JFreeChart object to be exported.
      * @param format Format (e.g. png, gif, jpg)
      * @param width Width, the image used to be
      * @param height Height, the image used to be
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/exports/Export.java	Wed Mar 31 10:56:39 2010 +0000
+++ b/gnv-artifacts/src/main/java/de/intevation/gnv/exports/Export.java	Wed Mar 31 12:18:03 2010 +0000
@@ -25,6 +25,12 @@
      * <code>Export</code>.
      */
     public interface Profile {
+        /**
+         *
+         * @param column Column index.
+         * @param value A default value.
+         * @return A specific column as string.
+         */
         String toString(int column, String value);
 
         /**
@@ -83,6 +89,8 @@
          * This method serves the required data stored in a <code>Result</code>
          * object.
          *
+         * @param result <code>Result</code> object which contains the required
+         * data.
          * @return String[] which contains all required data.
          *
          * @throws StateException
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/exports/ODVExport.java	Wed Mar 31 10:56:39 2010 +0000
+++ b/gnv-artifacts/src/main/java/de/intevation/gnv/exports/ODVExport.java	Wed Mar 31 12:18:03 2010 +0000
@@ -36,7 +36,9 @@
 
     /**
      * Constructor
-     * @param collector
+     * @param collector DataCollector used to extract the required data.
+     * @param parameters A collection of parameters to be displayed in the
+     * export.
      */
     public ODVExport(DataCollector collector, Collection parameters) {
         super(collector);

http://dive4elements.wald.intevation.org