Mercurial > dive4elements > gnv-client
changeset 788:e8a9e84a0328
Corrected JavaDoc errors in Chart Package.
gnv-artifacts/trunk@870 c6561f87-3c4e-4783-a992-168aeb5c3f6f
| author | Ingo Weinzierl <ingo.weinzierl@intevation.de> |
|---|---|
| date | Wed, 31 Mar 2010 08:01:56 +0000 |
| parents | 6cd8492019d8 |
| children | 0dc115cbef0d |
| files | gnv-artifacts/ChangeLog gnv-artifacts/src/main/java/de/intevation/gnv/chart/AbstractXYLineChart.java gnv-artifacts/src/main/java/de/intevation/gnv/chart/HorizontalCrossProfileChart.java gnv-artifacts/src/main/java/de/intevation/gnv/chart/HorizontalProfileChart.java gnv-artifacts/src/main/java/de/intevation/gnv/chart/TimeSeriesChart.java gnv-artifacts/src/main/java/de/intevation/gnv/chart/VerticalCrossSectionChart.java gnv-artifacts/src/main/java/de/intevation/gnv/chart/VerticalProfileChart.java gnv-artifacts/src/main/java/de/intevation/gnv/chart/XMLChartTheme.java |
| diffstat | 8 files changed, 35 insertions(+), 12 deletions(-) [+] |
line wrap: on
line diff
--- a/gnv-artifacts/ChangeLog Tue Mar 30 16:51:20 2010 +0000 +++ b/gnv-artifacts/ChangeLog Wed Mar 31 08:01:56 2010 +0000 @@ -1,3 +1,14 @@ +2010-03-30 Ingo Weinzierl <ingo.weinzierl@intevation.de> + + * src/main/java/de/intevation/gnv/chart/XMLChartTheme.java, + src/main/java/de/intevation/gnv/chart/HorizontalCrossProfileChart.java, + src/main/java/de/intevation/gnv/chart/VerticalCrossSectionChart.java, + src/main/java/de/intevation/gnv/chart/TimeSeriesChart.java, + src/main/java/de/intevation/gnv/chart/VerticalProfileChart.java, + src/main/java/de/intevation/gnv/chart/HorizontalProfileChart.java, + src/main/java/de/intevation/gnv/chart/AbstractXYLineChart.java: Corrected + JavaDoc errors. + 2010-03-30 Ingo Weinzierl <ingo.weinzierl@intevation.de> Issue214
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/chart/AbstractXYLineChart.java Tue Mar 30 16:51:20 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/chart/AbstractXYLineChart.java Wed Mar 31 08:01:56 2010 +0000 @@ -127,7 +127,7 @@ * chart creation. It turns an axis' label into a locale specific format. * * @param axis Axis to adjust. - * @param local java.util.Locale object used specify the format. + * @param locale java.util.Locale object used specify the format. */ protected abstract void localizeDomainAxis(Axis axis, Locale locale); @@ -278,6 +278,10 @@ plot.setRenderer(idx, renderer); } + + /** + * @return Index of the next color + */ protected static synchronized int nextColor() { return nextColor++; } @@ -302,9 +306,8 @@ * axis' label into a locale specific format. * * @param axis Axis to adjust. - * @param local java.util.Locale object used specify the format. + * @param locale java.util.Locale object used specify the format. * - * @param axis */ protected void localizeRangeAxis(Axis axis, Locale locale) { if (locale == null) @@ -355,7 +358,7 @@ * <code>percent</code> percent. * * @param dataset Dataset to be scaned. - * + * @param percent Percent used to expand the range. * @return JFreeChart Range object containing min and max y-value with a * margin. */
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/chart/HorizontalCrossProfileChart.java Tue Mar 30 16:51:20 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/chart/HorizontalCrossProfileChart.java Wed Mar 31 08:01:56 2010 +0000 @@ -1,7 +1,5 @@ package de.intevation.gnv.chart; -import de.intevation.gnv.chart.ChartLabels; - import de.intevation.gnv.geobackend.base.Result; import java.util.Collection;
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/chart/HorizontalProfileChart.java Tue Mar 30 16:51:20 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/chart/HorizontalProfileChart.java Wed Mar 31 08:01:56 2010 +0000 @@ -199,6 +199,7 @@ /** + * @param value * @see de.intevation.gnv.chart.VerticalProfileChart#storeMaxValue(Map, * Object, String) */ @@ -396,7 +397,7 @@ * @param end Last data point in a series * @param last Left point * @param current Right point - * + * @param count Number of datapoints * @return true, if a gap is detected between last and current - otherwise * false. */
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/chart/TimeSeriesChart.java Tue Mar 30 16:51:20 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/chart/TimeSeriesChart.java Wed Mar 31 08:01:56 2010 +0000 @@ -120,6 +120,7 @@ /** * see de.intevation.gnv.chart.AbstractXYLineChart#initChart() */ + @Override protected void initChart() { chart = ChartFactory.createTimeSeriesChart( labels.getTitle(), @@ -227,6 +228,7 @@ /** + * @param parameter * @see de.intevation.gnv.chart.AbstractXYLineChart#addSeries(Series, * String, int) */ @@ -283,6 +285,7 @@ /** + * @param locale * @see de.intevation.gnv.chart.AbstractXYLineChart#localizeDomainAxis(Axis, * Locale) */ @@ -294,6 +297,9 @@ /** + * @param zone + * @param locale + * @return TickUnitSource * @see org.jfree.chart.axis.DateAxis#createStandardDateTickUnits(TimeZone, * Locale) */ @@ -430,8 +436,9 @@ /** * Method to get a message from resource bundle. * - * @param Locale Locale used to specify the resource bundle. - * @param def Key to specify the required message. + * @param locale Locale used to specify the resource bundle. + * @param key Key to specify the required message. + * @param def Default string if resource is not existing. * * @return Message */
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/chart/VerticalCrossSectionChart.java Tue Mar 30 16:51:20 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/chart/VerticalCrossSectionChart.java Wed Mar 31 08:01:56 2010 +0000 @@ -323,6 +323,7 @@ /** * Set the background paint of {@link #chart}. + * @param paint */ public void setBackgroundPaint(Paint paint) { chart.setBackgroundPaint(paint);
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/chart/VerticalProfileChart.java Tue Mar 30 16:51:20 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/chart/VerticalProfileChart.java Wed Mar 31 08:01:56 2010 +0000 @@ -267,6 +267,7 @@ /** + * @param parameter * @see de.intevation.gnv.chart.AbstractXYLineChart#addSeries(Series, String, * int) */ @@ -350,6 +351,7 @@ /** + * @param locale * @see de.intevation.gnv.chart.AbstractXYLineChart#localizeDomainAxis(Axis, * Locale) */ @@ -526,6 +528,7 @@ * @param last Left value * @param current Right value * + * @param count * @return true, if a gap is detected between last and current - otherwise * false. */
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/chart/XMLChartTheme.java Tue Mar 30 16:51:20 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/chart/XMLChartTheme.java Wed Mar 31 08:01:56 2010 +0000 @@ -8,8 +8,6 @@ import java.awt.geom.Ellipse2D; -import java.lang.NumberFormatException; - import org.apache.log4j.Logger; import org.jfree.chart.StandardChartTheme; @@ -420,7 +418,7 @@ /** * Turns a string into a color using {@link java.awt.Color}. * - * @param Color as string + * @param color as string * * @return Color */ @@ -465,6 +463,7 @@ * * @param plot XYPlot */ + @Override protected void applyToXYPlot(XYPlot plot) { log.debug("apply theme parameter to XYPlot");