Mercurial > dive4elements > river
changeset 3270:4ac581062c40
Fix various documentation issues.
flys-artifacts/trunk@4913 c6561f87-3c4e-4783-a992-168aeb5c3f6f
line wrap: on
line diff
--- a/flys-artifacts/ChangeLog Tue Jul 10 11:10:38 2012 +0000 +++ b/flys-artifacts/ChangeLog Tue Jul 10 12:19:35 2012 +0000 @@ -1,3 +1,18 @@ +2012-07-10 Felix Wolfsteller <felix.wolfsteller@intevation.de> + + * src/main/java/de/intevation/flys/artifacts/WQKmsInterpolArtifact.java, + src/main/java/de/intevation/flys/exports/LongitudinalSectionGenerator.java, + src/main/java/de/intevation/flys/exports/ReferenceCurveExporter.java, + src/main/java/de/intevation/flys/exports/AbstractExporter.java, + src/main/java/de/intevation/flys/exports/ChartExportHelper.java, + src/main/java/de/intevation/flys/exports/InfoGeneratorHelper.java, + src/main/java/de/intevation/flys/exports/ChartGenerator.java, + src/main/java/de/intevation/flys/exports/MiddleBedHeightGenerator.java, + src/main/java/de/intevation/flys/exports/XYChartGenerator.java, + src/main/java/de/intevation/flys/exports/OutGenerator.java, + src/main/java/de/intevation/flys/exports/FlowVelocityGenerator.java: + Fix various documentation issues. + 2012-07-10 Felix Wolfsteller <felix.wolfsteller@intevation.de> * src/main/java/de/intevation/flys/artifacts/model/WQKms.java,
--- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/WQKmsInterpolArtifact.java Tue Jul 10 11:10:38 2012 +0000 +++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/WQKmsInterpolArtifact.java Tue Jul 10 12:19:35 2012 +0000 @@ -252,7 +252,7 @@ /** * Get WQKms from factory. - * @param TODO idx param is not needed + * @param idx param is not needed (TODO) * @return WQKms according to parameterization (can be null); */ public WQKms getWQKms(int idx) {
--- a/flys-artifacts/src/main/java/de/intevation/flys/exports/AbstractExporter.java Tue Jul 10 11:10:38 2012 +0000 +++ b/flys-artifacts/src/main/java/de/intevation/flys/exports/AbstractExporter.java Tue Jul 10 12:19:35 2012 +0000 @@ -55,7 +55,6 @@ /** XPath that points to the desired export facet. */ public static final String XPATH_FACET = "/art:action/@art:type"; - /** The document of the incoming out() request. */ protected Document request; @@ -92,11 +91,12 @@ * This method enables concrete subclasses to collected its own special * data. * - * @param artifacts The artifact that stores the data that has to be + * @param data The artifact that stores the data that has to be * exported. */ protected abstract void addData(Object data); + @Override public void init(Document request, OutputStream out, CallContext context) { logger.debug("AbstractExporter.init"); @@ -119,8 +119,8 @@ * store its data on its own. The real output creation takes place in the * concrete generate() methods. * - * @param artifact The artifact. - * @param facet The facet to add - NOTE: the facet needs to fit to the first + * @param artifactFacet The artifact and facet. + * The facet to add - NOTE: the facet needs to fit to the first * facet inserted into this exporter. Otherwise this artifact/facet is * skipped. * @param attr The attr document.
--- a/flys-artifacts/src/main/java/de/intevation/flys/exports/ChartExportHelper.java Tue Jul 10 11:10:38 2012 +0000 +++ b/flys-artifacts/src/main/java/de/intevation/flys/exports/ChartExportHelper.java Tue Jul 10 12:19:35 2012 +0000 @@ -90,8 +90,7 @@ * @param out OutputStream * @param chart JFreeChart object to be exported. * @param format Format (e.g. png, gif, jpg) - * @param width Width, the image used to be - * @param height Height, the image used to be + * @param cc context, in which e.g. size is stored. * * @throws IOException if writing image to OutputStream failed. */ @@ -168,14 +167,6 @@ * * @param out OutputStream * @param chart JFreeChart - * @param pageFormat String to specify a page format, {@link - * #DEFAULT_PAGE_SIZE} is used if no pageFormat is given - * @param landscape If this is true, the pdf is delivered in landscape - * format - * @param marginLeft Space to left border - * @param marginRight Space to right border - * @param marginTop Space to upper border - * @param marginBottom Space to lower border */ public static void exportPDF( OutputStream out, @@ -189,12 +180,12 @@ if (pageFormat == null) pageFormat = DEFAULT_PAGE_SIZE; - // max size of the chart + // Max size of the chart. Rectangle page = PageSize.getRectangle(pageFormat); float pageWidth = page.getWidth(); float pageHeight = page.getHeight(); - // the chart width + // The chart width. int[] size = getSize(cc); boolean landscape = size[0] > size[1];
--- a/flys-artifacts/src/main/java/de/intevation/flys/exports/ChartGenerator.java Tue Jul 10 11:10:38 2012 +0000 +++ b/flys-artifacts/src/main/java/de/intevation/flys/exports/ChartGenerator.java Tue Jul 10 12:19:35 2012 +0000 @@ -439,6 +439,7 @@ /** * Add the annotations (Sticky, Text and hyk zones) stored * in the annotations field. + * @param plot Plot to add annotations to. */ protected void addAnnotationsToRenderer(XYPlot plot) { logger.debug("addAnnotationsToRenderer"); @@ -566,7 +567,7 @@ /** * Combines the ranges of the X axis at index <i>idx</i>. * - * @param range A new range. + * @param bounds A new Bounds. * @param idx The index of the X axis that should be comined with * <i>range</i>. */ @@ -576,7 +577,7 @@ /** * Combines the ranges of the Y axis at index <i>idx</i>. * - * @param range A new range. + * @param bounds A new Bounds. * @param idx The index of the Y axis that should be comined with * <i>range</i>. */ @@ -1608,8 +1609,6 @@ * @param plot The plot. * @param area A StyledAreaSeriesCollection object. * @param idx The index of the dataset. - * - * @return */ protected void applyAreaTheme( XYPlot plot, @@ -1655,7 +1654,7 @@ /** * Expands a given range if it collapses into one point. * - * @param Range to be expanded if upper == lower bound. + * @param range Range to be expanded if upper == lower bound. * * @return Bounds of point plus 5 percent in each direction. */ @@ -1736,7 +1735,7 @@ * <i>createLegendLabelFont()</i>. * * @param theme The theme of the chart line. - * @param The displayed name of the item. + * @param name The displayed name of the item. * * @return a new LegendItem instance. */
--- a/flys-artifacts/src/main/java/de/intevation/flys/exports/FlowVelocityGenerator.java Tue Jul 10 11:10:38 2012 +0000 +++ b/flys-artifacts/src/main/java/de/intevation/flys/exports/FlowVelocityGenerator.java Tue Jul 10 12:19:35 2012 +0000 @@ -166,8 +166,9 @@ /** * Produce output. - * @param facet current facet. + * @param artifactAndFacet current facet. * @param attr theme for facet + * @param visible Whether this facets data is actually visible or not. */ public void doOut( ArtifactAndFacet artifactAndFacet, @@ -243,7 +244,7 @@ * Process the output for W facets in a longitudinal section curve. * * @param data A FlowVelocityData object - * @param facet The facet. This facet does NOT support any data objects. Use + * @param aandf The facet. 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. @@ -292,7 +293,7 @@ /** * @param data A FlowVelocityData object - * @param facet The facet. This facet does NOT support any data objects. Use + * @param aandf The facet. 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/InfoGeneratorHelper.java Tue Jul 10 11:10:38 2012 +0000 +++ b/flys-artifacts/src/main/java/de/intevation/flys/exports/InfoGeneratorHelper.java Tue Jul 10 12:19:35 2012 +0000 @@ -324,8 +324,8 @@ * coordinates of the chart image into chart coordinates. * * @param dataArea The rectangle that contains the data points of the chart. - * @param xRange The x axis range. - * @param yRange The y axis range. + * @param xAxis The x axis. + * @param yAxis The y axis. * * @return a double array as follows: [sx, sy, tx, ty]. */
--- a/flys-artifacts/src/main/java/de/intevation/flys/exports/LongitudinalSectionGenerator.java Tue Jul 10 11:10:38 2012 +0000 +++ b/flys-artifacts/src/main/java/de/intevation/flys/exports/LongitudinalSectionGenerator.java Tue Jul 10 12:19:35 2012 +0000 @@ -411,8 +411,8 @@ /** * Process the output for W 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 wkms WKms data. + * @param aandf The artifact and facet. 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. @@ -507,7 +507,7 @@ * account - if the x axis need to be inverted. Waterlines in these charts * should decrease. * - * @param wqkms The data object that stores the x and y values used for this + * @param wkms The data object that stores the x and y values used for this * chart. */ public boolean needInvertAxis(WKms wkms) {
--- a/flys-artifacts/src/main/java/de/intevation/flys/exports/MiddleBedHeightGenerator.java Tue Jul 10 11:10:38 2012 +0000 +++ b/flys-artifacts/src/main/java/de/intevation/flys/exports/MiddleBedHeightGenerator.java Tue Jul 10 12:19:35 2012 +0000 @@ -196,7 +196,7 @@ /** * @param data A data object - * @param facet The facet. This facet does NOT support any data objects. Use + * @param aandf The artifact and facet. 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/OutGenerator.java Tue Jul 10 11:10:38 2012 +0000 +++ b/flys-artifacts/src/main/java/de/intevation/flys/exports/OutGenerator.java Tue Jul 10 12:19:35 2012 +0000 @@ -41,7 +41,7 @@ * Creates the output of an Artifact and appends that single output to the * total output. * - * @param artifact The artifact that provides information and data for the + * @param bundle The Facet and artifact that provides information and data for the * single output. * @param attr A document that might contain some attributes used while * producing the output.
--- a/flys-artifacts/src/main/java/de/intevation/flys/exports/ReferenceCurveExporter.java Tue Jul 10 11:10:38 2012 +0000 +++ b/flys-artifacts/src/main/java/de/intevation/flys/exports/ReferenceCurveExporter.java Tue Jul 10 12:19:35 2012 +0000 @@ -174,7 +174,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("ReferenceCurveExporter.writeCSVHeader");
--- a/flys-artifacts/src/main/java/de/intevation/flys/exports/XYChartGenerator.java Tue Jul 10 11:10:38 2012 +0000 +++ b/flys-artifacts/src/main/java/de/intevation/flys/exports/XYChartGenerator.java Tue Jul 10 12:19:35 2012 +0000 @@ -401,7 +401,7 @@ /** * Effect: extend range of x axis to include given limits. * - * @param range the given ("minimal") range. + * @param bounds the given ("minimal") bounds. * @param index index of axis to be merged. */ @Override @@ -612,7 +612,7 @@ * * @param plot The XYPlot. * @param axis The axis the shoud be modified. - * @param range The whole range specified by a dataset. + * @param bounds The whole range specified by a dataset. * @param x A user defined range (null permitted). * * @return true, if a zoom range was specified, otherwise false. @@ -790,7 +790,7 @@ * Overrides the NumberFormat with the NumberFormat for the current locale * that is provided by getLocale(). * - * @param domainAxis The domain axis that needs localization. + * @param rangeAxis The domain axis that needs localization. */ protected void localizeRangeAxis(ValueAxis rangeAxis) { NumberFormat nf = NumberFormat.getInstance(getLocale());