# HG changeset patch # User Felix Wolfsteller # Date 1342034503 0 # Node ID d9af29a4bb852ab2915c4192d5bc4b9580ba0a32 # Parent a8ce3263b0a71696eecefb96a73f6d0446c61652 Various cosmetic doc fixes. flys-artifacts/trunk@4944 c6561f87-3c4e-4783-a992-168aeb5c3f6f diff -r a8ce3263b0a7 -r d9af29a4bb85 flys-artifacts/ChangeLog --- a/flys-artifacts/ChangeLog Wed Jul 11 16:05:24 2012 +0000 +++ b/flys-artifacts/ChangeLog Wed Jul 11 19:21:43 2012 +0000 @@ -1,3 +1,18 @@ +2012-07-11 Felix Wolfsteller + + * src/main/java/de/intevation/flys/artifacts/StaticWKmsArtifact.java, + src/main/java/de/intevation/flys/artifacts/ManualPointsArtifact.java, + src/main/java/de/intevation/flys/artifacts/CrossSectionArtifact.java, + src/main/java/de/intevation/flys/artifacts/states/LocationSelect.java, + src/main/java/de/intevation/flys/artifacts/states/DefaultState.java, + src/main/java/de/intevation/flys/utils/FLYSUtils.java, + src/main/java/de/intevation/flys/exports/ChartExportHelper.java, + src/main/java/de/intevation/flys/exports/WstWriter.java, + src/main/java/de/intevation/flys/exports/ChartGenerator.java, + src/main/java/de/intevation/flys/exports/StyledSeriesBuilder.java, + src/main/java/de/intevation/flys/jfree/StickyAxisAnnotation.java: + Various cosmetic doc fixes. + 2012-07-11 Felix Wolfsteller * doc/conf/meta-data.xml: Make official lines available in dc for diff -r a8ce3263b0a7 -r d9af29a4bb85 flys-artifacts/src/main/java/de/intevation/flys/artifacts/CrossSectionArtifact.java --- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/CrossSectionArtifact.java Wed Jul 11 16:05:24 2012 +0000 +++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/CrossSectionArtifact.java Wed Jul 11 19:21:43 2012 +0000 @@ -142,10 +142,13 @@ } + /** Returns next possible km for a cross-section. */ public Double getNextKm() { return getDataAsDouble(DATA_NEXT_KM); } + + /** Returns previous possible km for a cross-section. */ public Double getPrevKm() { return getDataAsDouble(DATA_PREV_KM); } diff -r a8ce3263b0a7 -r d9af29a4bb85 flys-artifacts/src/main/java/de/intevation/flys/artifacts/ManualPointsArtifact.java --- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/ManualPointsArtifact.java Wed Jul 11 16:05:24 2012 +0000 +++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/ManualPointsArtifact.java Wed Jul 11 19:21:43 2012 +0000 @@ -133,11 +133,16 @@ /** * Get the water line "surface". * @param index index of facets data. - * @param points 'ground' against which to determine water surface. - * @param data describing water surface. + * @param csl 'ground' against which to determine water surface. + * @param a (ignored in this implementation). + * @param b (ignored in this implementation). */ @Override - public Lines.LineData getWaterLines(int index, FastCrossSectionLine csl, double a, double b) { + public Lines.LineData getWaterLines( + int index, + FastCrossSectionLine csl, + double a, double b + ) { List points = csl.getPoints(); return Lines.createWaterLines(points, getLine(index)); } diff -r a8ce3263b0a7 -r d9af29a4bb85 flys-artifacts/src/main/java/de/intevation/flys/artifacts/StaticWKmsArtifact.java --- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/StaticWKmsArtifact.java Wed Jul 11 16:05:24 2012 +0000 +++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/StaticWKmsArtifact.java Wed Jul 11 19:21:43 2012 +0000 @@ -229,7 +229,7 @@ /** * Get WKms from factory. - * @param TODO idx param is not needed + * @param idx param is not needed (TODO?) * @return WKms according to parameterization (can be null); */ public WKms getWKms(int idx) { diff -r a8ce3263b0a7 -r d9af29a4bb85 flys-artifacts/src/main/java/de/intevation/flys/artifacts/states/DefaultState.java --- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/states/DefaultState.java Wed Jul 11 16:05:24 2012 +0000 +++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/states/DefaultState.java Wed Jul 11 19:21:43 2012 +0000 @@ -131,7 +131,7 @@ * document. * * @param creator The ElementCreator that is used to build new Elements. - * @param meta The CallMeta object used for i18n. + * @param cc The CallContext object used for nested i18n retrieval. * @param name The name of the data item. * @param value The value as string. * @@ -299,7 +299,6 @@ * items. * * @param cr The ElementCreator. - * @param name The name of the amount of data. * * @return the root node of the item list. */ diff -r a8ce3263b0a7 -r d9af29a4bb85 flys-artifacts/src/main/java/de/intevation/flys/artifacts/states/LocationSelect.java --- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/states/LocationSelect.java Wed Jul 11 16:05:24 2012 +0000 +++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/states/LocationSelect.java Wed Jul 11 19:21:43 2012 +0000 @@ -17,8 +17,9 @@ /** - * This state is used to realize the input of multiple locations as string. The - * string should be a whitespace separated list of double values where each + * This state is used to realize the input of multiple locations as string. + * + * The string should be a whitespace separated list of double values where each * double value represents a location. * * @author Ingo Weinzierl @@ -33,6 +34,7 @@ } + /** UI Provider (which input method should the client provide to user. */ @Override protected String getUIProvider() { return "location_panel"; @@ -75,6 +77,7 @@ } + /** Validates data from artifact. */ @Override public boolean validate(Artifact artifact) throws IllegalArgumentException diff -r a8ce3263b0a7 -r d9af29a4bb85 flys-artifacts/src/main/java/de/intevation/flys/exports/ChartExportHelper.java --- a/flys-artifacts/src/main/java/de/intevation/flys/exports/ChartExportHelper.java Wed Jul 11 16:05:24 2012 +0000 +++ b/flys-artifacts/src/main/java/de/intevation/flys/exports/ChartExportHelper.java Wed Jul 11 19:21:43 2012 +0000 @@ -89,7 +89,6 @@ * * @param out OutputStream * @param chart JFreeChart object to be exported. - * @param format Format (e.g. png, gif, jpg) * @param cc context, in which e.g. size is stored. * * @throws IOException if writing image to OutputStream failed. diff -r a8ce3263b0a7 -r d9af29a4bb85 flys-artifacts/src/main/java/de/intevation/flys/exports/ChartGenerator.java --- a/flys-artifacts/src/main/java/de/intevation/flys/exports/ChartGenerator.java Wed Jul 11 16:05:24 2012 +0000 +++ b/flys-artifacts/src/main/java/de/intevation/flys/exports/ChartGenerator.java Wed Jul 11 19:21:43 2012 +0000 @@ -545,7 +545,7 @@ * Combines the ranges of the Y axis at index idx. * * @param bounds A new Bounds. - * @param idx The index of the Y axis that should be comined with + * @param index The index of the Y axis that should be comined with. * range. */ protected abstract void combineYBounds(Bounds bounds, int index); @@ -1493,7 +1493,6 @@ * index 0), correlates with renderer index. * @param isArea true if the series describes an area and shall be rendered * as such. - * @return idx increased by number of items addded. */ protected void applyThemes( XYPlot plot, diff -r a8ce3263b0a7 -r d9af29a4bb85 flys-artifacts/src/main/java/de/intevation/flys/exports/StyledSeriesBuilder.java --- a/flys-artifacts/src/main/java/de/intevation/flys/exports/StyledSeriesBuilder.java Wed Jul 11 16:05:24 2012 +0000 +++ b/flys-artifacts/src/main/java/de/intevation/flys/exports/StyledSeriesBuilder.java Wed Jul 11 19:21:43 2012 +0000 @@ -129,7 +129,7 @@ * Add points to series (q to 1st dim, w to 2nd dim). * * @param series Series to add points to. - * @param wqksm WQKms to add to series. + * @param wqkms WQKms to add to series. */ public static void addPointsQW(XYSeries series, WQKms wqkms) { if (wqkms == null) { @@ -148,7 +148,7 @@ * Add points to series (q to 1st dim, w to 2nd dim). * * @param series Series to add points to. - * @param WWQQ WWQQ to add to series. + * @param wwqq WWQQ to add to series. */ public static void addPoints(XYSeries series, WWQQ wwqq) { if (wwqq == null) { diff -r a8ce3263b0a7 -r d9af29a4bb85 flys-artifacts/src/main/java/de/intevation/flys/exports/WstWriter.java --- a/flys-artifacts/src/main/java/de/intevation/flys/exports/WstWriter.java Wed Jul 11 16:05:24 2012 +0000 +++ b/flys-artifacts/src/main/java/de/intevation/flys/exports/WstWriter.java Wed Jul 11 19:21:43 2012 +0000 @@ -28,11 +28,9 @@ /** The logger used in this class. */ private static Logger logger = Logger.getLogger(WstWriter.class); - /** The default unit that is written into the header of the WST. */ public static final String DEFAULT_UNIT = "Wassserstand [NN + m]"; - /** The lines that need to be included for the export. */ protected Map lines; @@ -51,10 +49,8 @@ /** - * This constructor creates a new WstWriter with an OutputStream and a - * number of Q columns. + * This constructor creates a new WstWriter with a number of Q columns. * - * @param out The output stream where the WST is written to. * @param cols The number of columns of the resulting WST. */ public WstWriter(int cols) { @@ -68,6 +64,7 @@ /** * This method is used to create the WST from the data that has been * inserted using add(double[]) before. + * @param out Where to write to. */ public void write(OutputStream out) { logger.info("WstWriter.write"); diff -r a8ce3263b0a7 -r d9af29a4bb85 flys-artifacts/src/main/java/de/intevation/flys/jfree/StickyAxisAnnotation.java --- a/flys-artifacts/src/main/java/de/intevation/flys/jfree/StickyAxisAnnotation.java Wed Jul 11 16:05:24 2012 +0000 +++ b/flys-artifacts/src/main/java/de/intevation/flys/jfree/StickyAxisAnnotation.java Wed Jul 11 19:21:43 2012 +0000 @@ -58,7 +58,6 @@ * @param pos the position at which to draw the text and mark. * @param stickAxis the axis at which to stick (and to which 'pos' is * relative). - * @param lineTo upto where to draw a line (NaN for none). */ public StickyAxisAnnotation(String text, float pos, SimpleAxis stickAxis ) { @@ -66,6 +65,13 @@ } + /** + * Constructor with given explicit axis and axisSymbol + * @param text the text to display. + * @param pos the position at which to draw the text and mark. + * @param stickAxis the axis at which to stick (and to which 'pos' is + * relative). + */ public StickyAxisAnnotation(String text, float pos, SimpleAxis stickAxis, int axisSymbol ) { diff -r a8ce3263b0a7 -r d9af29a4bb85 flys-artifacts/src/main/java/de/intevation/flys/utils/FLYSUtils.java --- a/flys-artifacts/src/main/java/de/intevation/flys/utils/FLYSUtils.java Wed Jul 11 16:05:24 2012 +0000 +++ b/flys-artifacts/src/main/java/de/intevation/flys/utils/FLYSUtils.java Wed Jul 11 19:21:43 2012 +0000 @@ -451,6 +451,12 @@ } + /** + * Return the (first) Gauge corresponding to the given location(s) of + * the artifact. + * @param flys the artifact in question. + * @return (First) gauge of locations of river of artifact. + */ public static Gauge getGauge(FLYSArtifact flys) { River river = getRiver(flys);