Mercurial > dive4elements > gnv-client
changeset 817:3f447e92024a
Added JavaDoc package descriptions.
gnv-artifacts/trunk@902 c6561f87-3c4e-4783-a992-168aeb5c3f6f
line wrap: on
line diff
--- a/gnv-artifacts/ChangeLog Mon Apr 12 09:26:26 2010 +0000 +++ b/gnv-artifacts/ChangeLog Mon Apr 12 09:37:30 2010 +0000 @@ -1,3 +1,42 @@ +2010-04-12 Ingo Weinzierl <ingo.weinzierl@intevation.de> + + * src/main/java/de/intevation/gnv/artifacts/fis/product/package.html, + src/main/java/de/intevation/gnv/artifacts/fis/package.html, + src/main/java/de/intevation/gnv/artifacts/cache/package.html, + src/main/java/de/intevation/gnv/artifacts/context/package.html, + src/main/java/de/intevation/gnv/artifacts/ressource/package.html, + src/main/java/de/intevation/gnv/artifacts/package.html, + src/main/java/de/intevation/gnv/state/exception/package.html, + src/main/java/de/intevation/gnv/state/package.html, + src/main/java/de/intevation/gnv/state/profile/horizontalcrosssection/package.html, + src/main/java/de/intevation/gnv/state/profile/verticalcrosssection/package.html, + src/main/java/de/intevation/gnv/state/profile/horizontal/package.html, + src/main/java/de/intevation/gnv/state/profile/vertical/package.html, + src/main/java/de/intevation/gnv/state/timeseries/package.html, + src/main/java/de/intevation/gnv/state/describedata/package.html, + src/main/java/de/intevation/gnv/statistics/exception/package.html, + src/main/java/de/intevation/gnv/statistics/package.html, + src/main/java/de/intevation/gnv/histogram/package.html, + src/main/java/de/intevation/gnv/profile/horizontalcrosssection/package.html, + src/main/java/de/intevation/gnv/profile/verticalcrosssection/package.html, + src/main/java/de/intevation/gnv/profile/horizontal/package.html, + src/main/java/de/intevation/gnv/profile/vertical/package.html, + src/main/java/de/intevation/gnv/utils/exception/package.html, + src/main/java/de/intevation/gnv/utils/package.html, + src/main/java/de/intevation/gnv/chart/exception/package.html + src/main/java/de/intevation/gnv/chart/package.html, + src/main/java/de/intevation/gnv/exports/package.html, + src/main/java/de/intevation/gnv/wms/package.html, + src/main/java/de/intevation/gnv/timeseries/gap/package.html, + src/main/java/de/intevation/gnv/timeseries/package.html, + src/main/java/de/intevation/gnv/jfreechart/package.html: Added package + descriptions for the different packages. + + * src/main/java/de/intevation/gnv/artifacts/GNVArtifactFactory.java, + src/main/java/de/intevation/gnv/chart/VerticalCrossSectionChart.java, + src/main/java/de/intevation/gnv/chart/ChartLabels.java: Added missing + class descriptions. + 2010-04-12 Tim Englich <tim.englich@intevation.de> ISSUE 215 msg1189
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/GNVArtifactFactory.java Mon Apr 12 09:26:26 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/GNVArtifactFactory.java Mon Apr 12 09:37:30 2010 +0000 @@ -9,6 +9,8 @@ /** + * The GNV default implementation of <code>DefaultArtifactFactory</code>. + * * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a> */ public class GNVArtifactFactory extends DefaultArtifactFactory {
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/cache/package.html Mon Apr 12 09:26:26 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/cache/package.html Mon Apr 12 09:37:30 2010 +0000 @@ -3,6 +3,6 @@ <head> </head> <body> -DOCUMENT ME! +This package contains classes used for data caching. </body> </html>
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/context/package.html Mon Apr 12 09:26:26 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/context/package.html Mon Apr 12 09:37:30 2010 +0000 @@ -3,6 +3,7 @@ <head> </head> <body> -DOCUMENT ME! +Support for context objects that store data items used in the GNV in different +places across the whole application. </body> </html>
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/fis/package.html Mon Apr 12 09:26:26 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/fis/package.html Mon Apr 12 09:37:30 2010 +0000 @@ -3,6 +3,7 @@ <head> </head> <body> -DOCUMENT ME! +This package contains classes providing a special artifact used after a fis is +selected and the user needs to choose a concrete product. </body> </html>
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/fis/product/package.html Mon Apr 12 09:26:26 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/fis/product/package.html Mon Apr 12 09:37:30 2010 +0000 @@ -3,6 +3,7 @@ <head> </head> <body> -DOCUMENT ME! +Classes and interfaces representing a product (eg 'Horizontalschnitt', +'Horizontalprofil', 'Vertikalprofil', 'Profilschnitt', 'Zeitserien'). </body> </html>
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/package.html Mon Apr 12 09:26:26 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/package.html Mon Apr 12 09:37:30 2010 +0000 @@ -3,6 +3,7 @@ <head> </head> <body> -DOCUMENT ME! +Map user workflows to software components using classes and interfaces in this +package. </body> </html>
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/ressource/package.html Mon Apr 12 09:26:26 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/ressource/package.html Mon Apr 12 09:37:30 2010 +0000 @@ -3,6 +3,6 @@ <head> </head> <body> -DOCUMENT ME! +Classes to handle working with resources. </body> </html>
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/chart/ChartLabels.java Mon Apr 12 09:26:26 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/chart/ChartLabels.java Mon Apr 12 09:37:30 2010 +0000 @@ -13,6 +13,9 @@ package de.intevation.gnv.chart; /** + * This class stores some strings used for decorating charts (e.g. title, + * subtitle, etc). + * * @author drewnak * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> Changes and codecleanup * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a>
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/chart/VerticalCrossSectionChart.java Mon Apr 12 09:26:26 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/chart/VerticalCrossSectionChart.java Mon Apr 12 09:37:30 2010 +0000 @@ -35,6 +35,8 @@ import org.jfree.ui.RectangleInsets; /** + * This class represents a 2D chart containing polygon data. + * * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a> * @author <a href="mailto:sascha.teichmann@intevation.de">Sascha L. Teichmann</a> */
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/chart/exception/package.html Mon Apr 12 09:26:26 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/chart/exception/package.html Mon Apr 12 09:37:30 2010 +0000 @@ -3,6 +3,6 @@ <head> </head> <body> -DOCUMENT ME! +Exceptions that are used to be thrown if an error occured while chart generation. </body> </html>
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/chart/package.html Mon Apr 12 09:26:26 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/chart/package.html Mon Apr 12 09:37:30 2010 +0000 @@ -3,6 +3,6 @@ <head> </head> <body> -DOCUMENT ME! +Classes and interfaces to support creation of different chart types. </body> </html>
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/exports/package.html Mon Apr 12 09:26:26 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/exports/package.html Mon Apr 12 09:37:30 2010 +0000 @@ -3,6 +3,6 @@ <head> </head> <body> -DOCUMENT ME! +Handle different types of data exports (e.g. chart, csv, odv). </body> </html>
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/histogram/package.html Mon Apr 12 09:26:26 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/histogram/package.html Mon Apr 12 09:37:30 2010 +0000 @@ -3,6 +3,6 @@ <head> </head> <body> -DOCUMENT ME! +Helper classes used while histogram creation. </body> </html>
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/jfreechart/package.html Mon Apr 12 09:26:26 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/jfreechart/package.html Mon Apr 12 09:37:30 2010 +0000 @@ -3,6 +3,6 @@ <head> </head> <body> -DOCUMENT ME! +This package contains classes and interfaces used to create 2D charts. </body> </html>
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/profile/horizontal/package.html Mon Apr 12 09:26:26 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/profile/horizontal/package.html Mon Apr 12 09:37:30 2010 +0000 @@ -3,6 +3,7 @@ <head> </head> <body> -DOCUMENT ME! +This package contains classes providing specific artifacts representing +'Horizontalprofile'. </body> </html>
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/profile/horizontalcrosssection/package.html Mon Apr 12 09:26:26 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/profile/horizontalcrosssection/package.html Mon Apr 12 09:37:30 2010 +0000 @@ -3,6 +3,7 @@ <head> </head> <body> -DOCUMENT ME! +This package contains classes providing specific artifacts representing +'Horizontalschnitte'. </body> </html>
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/profile/vertical/package.html Mon Apr 12 09:26:26 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/profile/vertical/package.html Mon Apr 12 09:37:30 2010 +0000 @@ -3,6 +3,7 @@ <head> </head> <body> -DOCUMENT ME! +This package contains classes that provide specific artifacts representing +'Vertikalprofile'. </body> </html>
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/profile/verticalcrosssection/package.html Mon Apr 12 09:26:26 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/profile/verticalcrosssection/package.html Mon Apr 12 09:37:30 2010 +0000 @@ -3,6 +3,7 @@ <head> </head> <body> -DOCUMENT ME! +This package contains classes that provide specific artifacts representing +'Profilschnitte'. </body> </html>
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/state/describedata/package.html Mon Apr 12 09:26:26 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/state/describedata/package.html Mon Apr 12 09:37:30 2010 +0000 @@ -3,6 +3,6 @@ <head> </head> <body> -DOCUMENT ME! +Classes and interfaces to handle user input. </body> </html>
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/state/exception/package.html Mon Apr 12 09:26:26 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/state/exception/package.html Mon Apr 12 09:37:30 2010 +0000 @@ -3,6 +3,6 @@ <head> </head> <body> -DOCUMENT ME! +Exception classes to be thrown if error occur in state objects. </body> </html>
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/state/package.html Mon Apr 12 09:26:26 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/state/package.html Mon Apr 12 09:37:30 2010 +0000 @@ -3,6 +3,7 @@ <head> </head> <body> -DOCUMENT ME! +Classes in this package handle specific input/output of artifacts and even play a +decisive role for creating describe-documents of the current artifact's state. </body> </html>
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/state/profile/horizontal/package.html Mon Apr 12 09:26:26 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/state/profile/horizontal/package.html Mon Apr 12 09:37:30 2010 +0000 @@ -3,6 +3,7 @@ <head> </head> <body> -DOCUMENT ME! +State classes used by artifacts representing 'Horizontalprofile' to handle input +and output. </body> </html>
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/state/profile/horizontalcrosssection/package.html Mon Apr 12 09:26:26 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/state/profile/horizontalcrosssection/package.html Mon Apr 12 09:37:30 2010 +0000 @@ -3,6 +3,7 @@ <head> </head> <body> -DOCUMENT ME! +State classes used by artifacts representing 'Horizontalschnitte' to handle input +and output. </body> </html>
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/state/profile/vertical/package.html Mon Apr 12 09:26:26 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/state/profile/vertical/package.html Mon Apr 12 09:37:30 2010 +0000 @@ -3,6 +3,7 @@ <head> </head> <body> -DOCUMENT ME! +State classes used by artifacts representing 'Vertikalprofile' to handle input +and output. </body> </html>
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/state/profile/verticalcrosssection/package.html Mon Apr 12 09:26:26 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/state/profile/verticalcrosssection/package.html Mon Apr 12 09:37:30 2010 +0000 @@ -3,6 +3,7 @@ <head> </head> <body> -DOCUMENT ME! +State classes used by artifacts representing 'Profilschnitte' to handle input and +output. </body> </html>
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/state/timeseries/package.html Mon Apr 12 09:26:26 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/state/timeseries/package.html Mon Apr 12 09:37:30 2010 +0000 @@ -3,6 +3,7 @@ <head> </head> <body> -DOCUMENT ME! +State classes used by artifacts representing 'Zeitserien' to handle input and +output. </body> </html>
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/statistics/exception/package.html Mon Apr 12 09:26:26 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/statistics/exception/package.html Mon Apr 12 09:37:30 2010 +0000 @@ -3,6 +3,7 @@ <head> </head> <body> -DOCUMENT ME! +This package contains exception classes used to be thrown if error occur while +generating statistics. </body> </html>
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/statistics/package.html Mon Apr 12 09:26:26 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/statistics/package.html Mon Apr 12 09:37:30 2010 +0000 @@ -3,6 +3,7 @@ <head> </head> <body> -DOCUMENT ME! +This package contains classes and interfaces used to create statistics for the +different types of artifacts. </body> </html>
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/timeseries/gap/package.html Mon Apr 12 09:26:26 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/timeseries/gap/package.html Mon Apr 12 09:37:30 2010 +0000 @@ -3,6 +3,7 @@ <head> </head> <body> -DOCUMENT ME! +This package provides classes and interfaces representing time gaps used in +timerseries charts. </body> </html>
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/timeseries/package.html Mon Apr 12 09:26:26 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/timeseries/package.html Mon Apr 12 09:37:30 2010 +0000 @@ -3,6 +3,7 @@ <head> </head> <body> -DOCUMENT ME! +This package contains classes providing specific artifacts representing +'Zeitserien'. </body> </html>
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/utils/exception/package.html Mon Apr 12 09:26:26 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/utils/exception/package.html Mon Apr 12 09:37:30 2010 +0000 @@ -3,6 +3,6 @@ <head> </head> <body> -DOCUMENT ME! +Exception classes used by helper classes in the utils package. </body> </html>
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/utils/package.html Mon Apr 12 09:26:26 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/utils/package.html Mon Apr 12 09:37:30 2010 +0000 @@ -3,6 +3,6 @@ <head> </head> <body> -DOCUMENT ME! +This package provides some helper classes used across the whole software. </body> </html>
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/wms/package.html Mon Apr 12 09:26:26 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/wms/package.html Mon Apr 12 09:37:30 2010 +0000 @@ -3,6 +3,6 @@ <head> </head> <body> -DOCUMENT ME! +Classes used while generating mapfiles. </body> </html>