Mercurial > dive4elements > river
changeset 3269:b2ea89a665bc
Fix issues in 'documentation'.
flys-artifacts/trunk@4911 c6561f87-3c4e-4783-a992-168aeb5c3f6f
line wrap: on
line diff
--- a/flys-artifacts/ChangeLog Mon Jul 09 07:04:37 2012 +0000 +++ b/flys-artifacts/ChangeLog Tue Jul 10 11:10:38 2012 +0000 @@ -1,3 +1,19 @@ +2012-07-10 Felix Wolfsteller <felix.wolfsteller@intevation.de> + + * src/main/java/de/intevation/flys/artifacts/model/WQKms.java, + src/main/java/de/intevation/flys/artifacts/model/CrossSectionFactory.java, + src/main/java/de/intevation/flys/artifacts/model/DischargeTables.java, + src/main/java/de/intevation/flys/artifacts/model/WstValueTableFactory.java, + src/main/java/de/intevation/flys/artifacts/model/fixings/FixWQCurveFacet.java, + src/main/java/de/intevation/flys/artifacts/transitions/DefaultTransition.java, + src/main/java/de/intevation/flys/exports/LongitudinalSectionGenerator.java, + src/main/java/de/intevation/flys/exports/WDifferencesExporter.java, + src/main/java/de/intevation/flys/exports/ChartHelper.java, + src/main/java/de/intevation/flys/exports/MiddleBedHeightGenerator.java, + src/main/java/de/intevation/flys/exports/StyledSeriesBuilder.java, + src/main/java/de/intevation/flys/jfree/StickyAxisAnnotation.java: + Fix various issues in the hard-to-find documentation. + 2012-07-09 Felix Wolfsteller <felix.wolfsteller@intevation.de> * pom.xml: Configure javadoc mojo to include doc for protected/private.
--- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/CrossSectionFactory.java Mon Jul 09 07:04:37 2012 +0000 +++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/CrossSectionFactory.java Tue Jul 10 11:10:38 2012 +0000 @@ -38,7 +38,7 @@ /** * Get Cross Sections for a river by name. * - * @param river name of the river of interest. + * @param riverName name of the river of interest. * * @return List of Cross Sections of river. */
--- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/DischargeTables.java Mon Jul 09 07:04:37 2012 +0000 +++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/DischargeTables.java Tue Jul 10 11:10:38 2012 +0000 @@ -139,8 +139,6 @@ /** * @param table The discharge table * @param scale The scale factor to adjust W and Q values. - * @param qSorted Boolean flag that is used to evaluate if the values should - * be sorted. * * @return the values of a discharge table. */
--- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/WQKms.java Mon Jul 09 07:04:37 2012 +0000 +++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/WQKms.java Tue Jul 10 11:10:38 2012 +0000 @@ -62,7 +62,7 @@ * * @param w a W. * @param q a Q. - * @param kms a Kms. + * @param km a kms. */ public void add(double w, double q, double km) { super.add(w, q);
--- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/WstValueTableFactory.java Mon Jul 09 07:04:37 2012 +0000 +++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/WstValueTableFactory.java Tue Jul 10 11:10:38 2012 +0000 @@ -228,10 +228,12 @@ /** * Load rows with a single columns result. + * * @param session session to use for querying db. - * @param wst_id id of wst (in db). + * @param wstId id of wst (in db). * @param column_pos the column_pos (within the db) of the wst_value_table * of which the values shall be fetched. + * * @return resultant rows. */ protected static List<WstValueTable.Row> loadRowsOneColumn(
--- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/fixings/FixWQCurveFacet.java Mon Jul 09 07:04:37 2012 +0000 +++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/fixings/FixWQCurveFacet.java Tue Jul 10 11:10:38 2012 +0000 @@ -39,7 +39,7 @@ /** - * @param name + * @param description Description of the facet. */ public FixWQCurveFacet(String description) { super(0, FIX_WQ_CURVE, description, ComputeType.ADVANCE, null, null);
--- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/transitions/DefaultTransition.java Mon Jul 09 07:04:37 2012 +0000 +++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/transitions/DefaultTransition.java Tue Jul 10 11:10:38 2012 +0000 @@ -69,7 +69,7 @@ /** * Set the current state ID. * - * @param to the current state ID. + * @param from current state ID. */ public void setFrom(String from) { this.from = from;
--- a/flys-artifacts/src/main/java/de/intevation/flys/exports/ChartHelper.java Mon Jul 09 07:04:37 2012 +0000 +++ b/flys-artifacts/src/main/java/de/intevation/flys/exports/ChartHelper.java Tue Jul 10 11:10:38 2012 +0000 @@ -160,7 +160,7 @@ * @param bounds The bounds to expand. * @param percent The percentage to expand. * - * @param a new, expanded bounds. + * @return a new, expanded bounds. */ public static Bounds expandBounds(Bounds bounds, double percent) { if (bounds == null) { @@ -182,7 +182,7 @@ * @param range The range to expand. * @param percent The percentage to expand. * - * @param a new, expanded range. + * @return a new, expanded range. */ public static Range expandRange(Range range, double percent) { if (range == null) {
--- a/flys-artifacts/src/main/java/de/intevation/flys/exports/LongitudinalSectionGenerator.java Mon Jul 09 07:04:37 2012 +0000 +++ b/flys-artifacts/src/main/java/de/intevation/flys/exports/LongitudinalSectionGenerator.java Tue Jul 10 11:10:38 2012 +0000 @@ -312,7 +312,7 @@ /** * Produce output. - * @param facet current facet. + * @param artifactAndFacet current facet and artifact. * @param attr theme for facet */ public void doOut( @@ -477,7 +477,7 @@ * Process the output for Q facets in a longitudinal section curve. * * @param wqkms An array of WQKms values. - * @param facet The facet. This facet does NOT support any data objects. Use + * @param aandf The facet and artifact. This facet does NOT support any data objects. Use * FLYSArtifact.getNativeFacet() instead to retrieve a Facet which supports * data. * @param theme The theme that contains styling information.
--- a/flys-artifacts/src/main/java/de/intevation/flys/exports/MiddleBedHeightGenerator.java Mon Jul 09 07:04:37 2012 +0000 +++ b/flys-artifacts/src/main/java/de/intevation/flys/exports/MiddleBedHeightGenerator.java Tue Jul 10 11:10:38 2012 +0000 @@ -135,7 +135,7 @@ /** * Produce output. - * @param facet current facet. + * @param artifactAndFacet current facet. * @param attr theme for facet */ public void doOut(
--- a/flys-artifacts/src/main/java/de/intevation/flys/exports/StyledSeriesBuilder.java Mon Jul 09 07:04:37 2012 +0000 +++ b/flys-artifacts/src/main/java/de/intevation/flys/exports/StyledSeriesBuilder.java Tue Jul 10 11:10:38 2012 +0000 @@ -60,7 +60,7 @@ * Add points to series (km to 1st dim, w to 2nd dim). * * @param series Series to add points to. - * @param points Points to add to series. + * @param wkms WKms to add to series. */ public static void addPoints(XYSeries series, WKms wkms) { if (wkms == null) { @@ -79,7 +79,7 @@ * Add points to series (km to 1st dim, q to 2nd dim). * * @param series Series to add points to. - * @param points Points to add to series. + * @param wqkms WQKms to add to series. */ public static void addPointsKmQ(XYSeries series, WQKms wqkms) { if (wqkms == null) { @@ -99,7 +99,7 @@ * to achieve a step-like curve. * * @param series Series to add points to. - * @param points Points to add to series. + * @param wqkms WQKms to add to series. */ public static void addStepPointsKmQ(XYSeries series, WQKms wqkms) { if (wqkms == null) { @@ -129,7 +129,7 @@ * Add points to series (q to 1st dim, w to 2nd dim). * * @param series Series to add points to. - * @param points Points to add to series. + * @param wqksm 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 points Points to add to series. + * @param WWQQ WWQQ to add to series. */ public static void addPoints(XYSeries series, WWQQ wwqq) { if (wwqq == null) {
--- a/flys-artifacts/src/main/java/de/intevation/flys/exports/WDifferencesExporter.java Mon Jul 09 07:04:37 2012 +0000 +++ b/flys-artifacts/src/main/java/de/intevation/flys/exports/WDifferencesExporter.java Tue Jul 10 11:10:38 2012 +0000 @@ -132,7 +132,7 @@ /** * Lets csvwriter write the header (first line in file). - * @param write Writer to write header with. + * @param writer Writer to write header with. */ protected void writeCSVHeader(CSVWriter writer) { logger.info("WDifferencesExporter.writeCSVHeader");
--- a/flys-artifacts/src/main/java/de/intevation/flys/jfree/StickyAxisAnnotation.java Mon Jul 09 07:04:37 2012 +0000 +++ b/flys-artifacts/src/main/java/de/intevation/flys/jfree/StickyAxisAnnotation.java Tue Jul 10 11:10:38 2012 +0000 @@ -44,8 +44,8 @@ /** * Constructor with implicit sticky x-axis. - * @param text the text to display. - * @param pos the position at which to draw the text and mark. + * @param text the text to display. + * @param pos the position at which to draw the text and mark. */ public StickyAxisAnnotation(String text, float pos) { this(text, pos, SimpleAxis.X_AXIS); @@ -56,7 +56,7 @@ * Constructor with given explicit axis. * @param text the text to display. * @param pos the position at which to draw the text and mark. - * @param stickyAxis the axis at which to stick (and to which 'pos' is + * @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). */