# HG changeset patch
# User Felix Wolfsteller <felix.wolfsteller@intevation.de>
# Date 1320236192 0
# Node ID a9b690d864a780c5a08cb485d1903378978fb8b7
# Parent  b3a67d946568501a371575cb65898e84ef0c23cb
Cosmetics, doc.

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

diff -r b3a67d946568 -r a9b690d864a7 flys-artifacts/ChangeLog
--- a/flys-artifacts/ChangeLog	Wed Nov 02 12:15:58 2011 +0000
+++ b/flys-artifacts/ChangeLog	Wed Nov 02 12:16:32 2011 +0000
@@ -1,3 +1,8 @@
+2011-11-02	Felix Wolfsteller	<felix.wolfsteller@intevation.de>
+
+	* src/main/java/de/intevation/flys/exports/StyledXYSeries.java:
+	  Documentation added.
+
 2011-11-02	Felix Wolfsteller	<felix.wolfsteller@intevation.de>
 
 	* src/main/java/de/intevation/flys/artifacts/model/ManagedDomFacet.java:
diff -r b3a67d946568 -r a9b690d864a7 flys-artifacts/src/main/java/de/intevation/flys/exports/StyledXYSeries.java
--- a/flys-artifacts/src/main/java/de/intevation/flys/exports/StyledXYSeries.java	Wed Nov 02 12:15:58 2011 +0000
+++ b/flys-artifacts/src/main/java/de/intevation/flys/exports/StyledXYSeries.java	Wed Nov 02 12:16:32 2011 +0000
@@ -13,12 +13,14 @@
 
 import de.intevation.flys.utils.ThemeUtil;
 
-
+/**
+ * Dataset in two dimensions with additional theme-document.
+ * The theme-document will later "style" the graphical representation.
+ */
 public class StyledXYSeries extends XYSeries {
 
     protected Document theme;
 
-
     private static final Logger logger = Logger.getLogger(StyledXYSeries.class);
 
 
@@ -26,6 +28,12 @@
         this(key, true, theme);
     }
 
+
+    /**
+     * @param sorted whether or not to sort the points. Sorting will move NANs
+     *               to one extrema which can cause problems in certain
+     *               algorithms.
+     */
     public StyledXYSeries(String key, boolean sorted, Document theme) {
         super(key, sorted);
         this.theme = theme;