changeset 2710:013882485011

Cosmetics (docs). flys-artifacts/trunk@4432 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Felix Wolfsteller <felix.wolfsteller@intevation.de>
date Wed, 16 May 2012 20:17:24 +0000
parents cd6bcca17de6
children fa8ae7dbcb72
files flys-artifacts/ChangeLog flys-artifacts/src/main/java/de/intevation/flys/exports/XYChartGenerator.java
diffstat 2 files changed, 18 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/flys-artifacts/ChangeLog	Wed May 16 15:09:55 2012 +0000
+++ b/flys-artifacts/ChangeLog	Wed May 16 20:17:24 2012 +0000
@@ -1,3 +1,8 @@
+2012-05-16  Felix Wolfsteller <felix.wolfsteller@intevation.de>
+
+	* src/main/java/de/intevation/flys/exports/XYChartGenerator.java:
+	  Extensive - although mostly trivial - doc adds.
+
 2012-05-16  Ingo Weinzierl <ingo@intevation.de>
 
 	* doc/conf/artifacts/minfo.xml: Added states and transitions for MINFO
--- a/flys-artifacts/src/main/java/de/intevation/flys/exports/XYChartGenerator.java	Wed May 16 15:09:55 2012 +0000
+++ b/flys-artifacts/src/main/java/de/intevation/flys/exports/XYChartGenerator.java	Wed May 16 20:17:24 2012 +0000
@@ -107,6 +107,7 @@
         }
 
 
+        /** Add a dataset to internal list for this axis. */
         @Override
         public void addDataset(XYDataset dataset) {
             datasets.add(dataset);
@@ -119,24 +120,29 @@
         }
 
 
+        /** Set Range for this axis. */
         @Override
         public void setRange(Range range) {
             this.range = range;
         }
 
 
+        /** Get Range for this axis. */
         @Override
         public Range getRange() {
             return range;
         }
 
 
+        /** Get Array of Datasets. */
         @Override
         public XYDataset[] getDatasets() {
             return (XYDataset[])
                 datasets.toArray(new XYDataset[datasets.size()]);
         }
 
+
+        /** Add a Dataset that describes an area. */
         public void addArea(StyledAreaSeriesCollection series) {
             this.datasets.add(series);
         }
@@ -172,6 +178,7 @@
         }
     } // class AxisDataset
 
+    /** Enumerator over existing axes. */
     protected abstract YAxisWalker getYAxisWalker();
 
     public static final int AXIS_SPACE = 5;
@@ -622,7 +629,7 @@
 
 
     /**
-     * This method extracts the minimum and maximum values for x and y axes
+     * Extract the minimum and maximum values for x and y axes
      * which are stored in <i>xRanges</i> and <i>yRanges</i>.
      *
      * @param index The index of the y-Axis.
@@ -654,24 +661,28 @@
     }
 
 
+    /** Get X (usually horizontal) extent for given axis. */
     @Override
     public Bounds getXBounds(int axis) {
         return xBounds.get(axis);
     }
 
 
+    /** Set X (usually horizontal) extent for given axis. */
     @Override
     protected void setXBounds(int axis, Bounds bounds) {
         xBounds.put(axis, bounds);
     }
 
 
+    /** Get Y (usually vertical) extent for given axis. */
     @Override
     public Bounds getYBounds(int axis) {
         return yBounds.get(axis);
     }
 
 
+    /** Set Y (usually vertical) extent for given axis. */
     @Override
     protected void setYBounds(int axis, Bounds bounds) {
         yBounds.put(axis, bounds);
@@ -1106,6 +1117,7 @@
         if (items.size() == 1) {
             return items.get(0).getLabel();
         }
+
         // TODO consider using regionMathches for implementation.
         int lastMatchedChar = 0;
         boolean first = true;

http://dive4elements.wald.intevation.org