# HG changeset patch
# User Felix Wolfsteller <felix.wolfsteller@intevation.de>
# Date 1338280719 0
# Node ID 60f13d966ee383b2573c6be8e081eec1597d8dba
# Parent  55f91fae8a7b9f65497741a769f93d4b71cd197d
Doc and TODOs added.

flys-artifacts/trunk@4552 c6561f87-3c4e-4783-a992-168aeb5c3f6f

diff -r 55f91fae8a7b -r 60f13d966ee3 flys-artifacts/ChangeLog
--- a/flys-artifacts/ChangeLog	Tue May 29 08:23:03 2012 +0000
+++ b/flys-artifacts/ChangeLog	Tue May 29 08:38:39 2012 +0000
@@ -1,3 +1,8 @@
+2012-05-29	Felix Wolfsteller	<felix.wolfsteller@intevation.de>
+
+	* src/main/java/de/intevation/flys/exports/XYChartGenerator.java:
+	  Doc, TODOs added.
+
 2012-05-29	Felix Wolfsteller	<felix.wolfsteller@intevation.de>
 
 	* src/main/java/de/intevation/flys/utils/ThemeUtil.java
diff -r 55f91fae8a7b -r 60f13d966ee3 flys-artifacts/src/main/java/de/intevation/flys/exports/XYChartGenerator.java
--- a/flys-artifacts/src/main/java/de/intevation/flys/exports/XYChartGenerator.java	Tue May 29 08:23:03 2012 +0000
+++ b/flys-artifacts/src/main/java/de/intevation/flys/exports/XYChartGenerator.java	Tue May 29 08:38:39 2012 +0000
@@ -713,6 +713,13 @@
         }
     }
 
+
+    /**
+     * Create annotation that sticks to "ground" (X) axis.
+     * @param area helper to calculate coordinates
+     * @param pos one-dimensional position (distance from axis)
+     * @param lineStyle the line style to use for the line.
+     */
     protected static XYLineAnnotation createGroundStickAnnotation(
         Area area, float pos, ThemeAccess.LineStyle lineStyle
     ) {
@@ -731,6 +738,12 @@
     }
 
 
+    /**
+     * Create annotation that sticks to the second Y axis ("right").
+     * @param area helper to calculate coordinates
+     * @param pos one-dimensional position (distance from axis)
+     * @param lineStyle the line style to use for the line.
+     */
     protected static XYLineAnnotation createRightStickAnnotation(
         Area area, float pos, ThemeAccess.LineStyle lineStyle
     ) {
@@ -749,6 +762,12 @@
     }
 
 
+    /**
+     * Create annotation that sticks to the second Y axis ("right").
+     * @param area helper to calculate coordinates
+     * @param pos one-dimensional position (distance from axis)
+     * @param lineStyle the line style to use for the line.
+     */
     protected static XYLineAnnotation createLeftStickAnnotation(
         Area area, float pos, ThemeAccess.LineStyle lineStyle
     ) {
@@ -766,6 +785,7 @@
         }
     }
 
+
     /**
      * Add a text and a line annotation.
      * @param area convenience to determine positions in plot.
@@ -830,6 +850,7 @@
                     // New line annotation to hit curve.
                     // TODO include more style information
                     if (ThemeUtil.parseShowVerticalLine(theme)) {
+                        // createRightStickAnnotaiton .... 
                         XYLineAnnotation hitLineAnnotation = new XYLineAnnotation(
                             area2.atRight(), annotation.getPos(),
                             annotation.getHitPoint(), annotation.getPos());
@@ -837,6 +858,7 @@
                             org.jfree.ui.Layer.BACKGROUND);
                     }
                     if (ThemeUtil.parseShowHorizontalLine(theme)) {
+                        // createGroundStickAnnotation
                         XYLineAnnotation lineBackAnnotation = new XYLineAnnotation(
                             annotation.getHitPoint(), annotation.getPos(),
                             annotation.getHitPoint(), area2.atGround());
@@ -855,12 +877,14 @@
                     // TODO include more style information
                     // New line annotation to hit curve.
                     if (ThemeUtil.parseShowHorizontalLine(theme)) {
+                        // createLeftStickAnnotaiton
                         XYLineAnnotation hitLineAnnotation = new XYLineAnnotation(area.atLeft(),
                             annotation.getPos(), annotation.getHitPoint(), annotation.getPos());
                         plot.getRenderer(rendererIndex).addAnnotation(hitLineAnnotation,
                             org.jfree.ui.Layer.BACKGROUND);
                     }
                     if (ThemeUtil.parseShowVerticalLine(theme)) {
+                        // createGroundStickAnnotation
                         XYLineAnnotation lineBackAnnotation = new XYLineAnnotation(
                             annotation.getHitPoint(), annotation.getPos(),
                             annotation.getHitPoint(), area.atGround());