From d43296c82e0a9409137410e64c85603362b82602 Mon Sep 17 00:00:00 2001 From: albert-github Date: Thu, 4 Jul 2019 13:52:30 +0200 Subject: [PATCH] Documentation corrections Some "obvious" code documentation corrections. --- src/ext/plantuml/com/ctreber/acearth/ACearth.java | 5 ++--- src/ext/plantuml/com/ctreber/acearth/MapData.java | 5 ++--- src/ext/plantuml/com/ctreber/acearth/MapDataReader.java | 2 -- src/ext/plantuml/com/google/zxing/Writer.java | 4 ---- src/jcckit/GraphicsPlotCanvas.java | 2 +- src/jcckit/graphic/GraphicalComposite.java | 1 + src/jcckit/graphic/Polygon.java | 1 + src/jcckit/graphic/ShapeAttributes.java | 2 +- src/jcckit/plot/Hint.java | 4 ++-- src/jcckit/plot/SimpleCurveFactory.java | 4 ++-- src/jcckit/plot/TicLabelMap.java | 2 +- src/jcckit/util/ConfigData.java | 2 +- src/jcckit/util/Format.java | 6 +++--- src/net/sourceforge/plantuml/brotli/Utils.java | 8 ++++---- src/net/sourceforge/plantuml/core/ImageData.java | 6 +++--- src/net/sourceforge/plantuml/swing/ImageHelper.java | 2 +- src/net/sourceforge/plantuml/zopfli/Cookie.java | 2 +- src/org/stathissideris/ascii2image/graphics/Diagram.java | 4 ++-- .../stathissideris/ascii2image/graphics/DiagramShape.java | 1 + .../stathissideris/ascii2image/graphics/ShapeEdge.java | 2 +- src/org/stathissideris/ascii2image/text/TextGrid.java | 2 +- 21 files changed, 31 insertions(+), 36 deletions(-) mode change 100644 => 100755 src/ext/plantuml/com/google/zxing/Writer.java mode change 100644 => 100755 src/jcckit/plot/SimpleCurveFactory.java diff --git a/src/ext/plantuml/com/ctreber/acearth/ACearth.java b/src/ext/plantuml/com/ctreber/acearth/ACearth.java index 54adad5fc..0b3c8e78c 100644 --- a/src/ext/plantuml/com/ctreber/acearth/ACearth.java +++ b/src/ext/plantuml/com/ctreber/acearth/ACearth.java @@ -36,8 +36,7 @@ import ext.plantuml.com.ctreber.aclib.sort.CTSort; import ext.plantuml.com.ctreber.aclib.sort.QuickSort; /** - *

AC.earth - XEarth for Java - *

+ *

AC.earth - XEarth for Java

* *

* The original XEarth was written by Kirk Johnson in July 1993 - thank you for @@ -370,4 +369,4 @@ public class ACearth { return fConf; } -} \ No newline at end of file +} diff --git a/src/ext/plantuml/com/ctreber/acearth/MapData.java b/src/ext/plantuml/com/ctreber/acearth/MapData.java index b1f66a731..d73641c1f 100644 --- a/src/ext/plantuml/com/ctreber/acearth/MapData.java +++ b/src/ext/plantuml/com/ctreber/acearth/MapData.java @@ -4,8 +4,7 @@ import java.util.ArrayList; import java.util.List; /** - *

AC.earth - XEarth for Java - *

+ *

AC.earth - XEarth for Java

* *

* The original XEarth was written by Kirk Johnson in July 1993 - thank you for @@ -6832,4 +6831,4 @@ public class MapData { } -} \ No newline at end of file +} diff --git a/src/ext/plantuml/com/ctreber/acearth/MapDataReader.java b/src/ext/plantuml/com/ctreber/acearth/MapDataReader.java index f768c7ef8..e30f45e3b 100644 --- a/src/ext/plantuml/com/ctreber/acearth/MapDataReader.java +++ b/src/ext/plantuml/com/ctreber/acearth/MapDataReader.java @@ -44,8 +44,6 @@ public class MapDataReader { *

* Read map data. * - * @param pFileName - * Map data file name. * @return Array of map polygons. * @throws IOException */ diff --git a/src/ext/plantuml/com/google/zxing/Writer.java b/src/ext/plantuml/com/google/zxing/Writer.java old mode 100644 new mode 100755 index 6d04bf01c..90162a575 --- a/src/ext/plantuml/com/google/zxing/Writer.java +++ b/src/ext/plantuml/com/google/zxing/Writer.java @@ -32,8 +32,6 @@ public interface Writer { * * @param contents The contents to encode in the barcode * @param format The barcode format to generate - * @param width The preferred width in pixels - * @param height The preferred height in pixels * @return The generated barcode as a Matrix of unsigned bytes (0 == black, 255 == white) */ BitMatrix encode(String contents, BarcodeFormat format, int multiple) @@ -43,8 +41,6 @@ public interface Writer { * * @param contents The contents to encode in the barcode * @param format The barcode format to generate - * @param width The preferred width in pixels - * @param height The preferred height in pixels * @param hints Additional parameters to supply to the encoder * @return The generated barcode as a Matrix of unsigned bytes (0 == black, 255 == white) */ diff --git a/src/jcckit/GraphicsPlotCanvas.java b/src/jcckit/GraphicsPlotCanvas.java index 5d2b41b4a..21527d677 100644 --- a/src/jcckit/GraphicsPlotCanvas.java +++ b/src/jcckit/GraphicsPlotCanvas.java @@ -93,7 +93,7 @@ public class GraphicsPlotCanvas extends PlotCanvas { * Foreground color of the wrapped AWT component. * * - * doubleBuffering = true + * doubleBuffering = true * booleanno * If true the plot will be painted by using * double-buffering and pre-rendered view of the coordinate system. diff --git a/src/jcckit/graphic/GraphicalComposite.java b/src/jcckit/graphic/GraphicalComposite.java index b981343d7..d7d609206 100644 --- a/src/jcckit/graphic/GraphicalComposite.java +++ b/src/jcckit/graphic/GraphicalComposite.java @@ -66,6 +66,7 @@ public class GraphicalComposite implements GraphicalElement { /** * Replaces the specified element at the specified index of * the list of elements. + * @param index Index of the element to be replaced. * @param element New element. null is not allowed. * @throws NullPointerException if element == null */ diff --git a/src/jcckit/graphic/Polygon.java b/src/jcckit/graphic/Polygon.java index 45245b4d8..9c379d807 100644 --- a/src/jcckit/graphic/Polygon.java +++ b/src/jcckit/graphic/Polygon.java @@ -31,6 +31,7 @@ public class Polygon extends BasicGraphicalElement { /** * Creates an instance of the specified graphic attributes. + * @param attributes attributes of the instance to be created * @param closed true if this polygon is closed. */ public Polygon(GraphicAttributes attributes, boolean closed) { diff --git a/src/jcckit/graphic/ShapeAttributes.java b/src/jcckit/graphic/ShapeAttributes.java index 362f3037d..9fa4c7301 100644 --- a/src/jcckit/graphic/ShapeAttributes.java +++ b/src/jcckit/graphic/ShapeAttributes.java @@ -47,7 +47,7 @@ public class ShapeAttributes implements LineAttributes, FillAttributes { * Description * fillColor = no fillingColor * noThe fill color of the shape. - * lineColor = no lineColor + * lineColor = no lineColor * noThe color of a line, a polygon, or the border of a shape. * lineThickness = 0double * no diff --git a/src/jcckit/plot/Hint.java b/src/jcckit/plot/Hint.java index ff565b8f4..18714dc08 100644 --- a/src/jcckit/plot/Hint.java +++ b/src/jcckit/plot/Hint.java @@ -21,8 +21,8 @@ package jcckit.plot; /** * Marker interface of all types of hints. Hints are used to calculate - * {@link jcckit.graphic.GraphicalElement} representing a point in a {@link - * Curve}. For example, in a chart with stacked + * {@link jcckit.graphic.GraphicalElement} representing a point in a + * {@link Curve}. For example, in a chart with stacked * bars the data determines the height of a bar but the foot of * a bar is determined by the height of the bar below. Its value will be * stored in a {@link PositionHint}. diff --git a/src/jcckit/plot/SimpleCurveFactory.java b/src/jcckit/plot/SimpleCurveFactory.java old mode 100644 new mode 100755 index 4d7b2bc02..48b1c8972 --- a/src/jcckit/plot/SimpleCurveFactory.java +++ b/src/jcckit/plot/SimpleCurveFactory.java @@ -42,8 +42,8 @@ public class SimpleCurveFactory implements CurveFactory { * * * - * + * * *
Key & Default ValueTypeMandatoryDescription
definitions = one empty ConfigParameters - * instance
definitions = one empty ConfigParameters + * instanceString[]noKeys of subtrees defining {@link ConfigParameters} * used by the {@link SimpleCurve#SimpleCurve constructor} of diff --git a/src/jcckit/plot/TicLabelMap.java b/src/jcckit/plot/TicLabelMap.java index d2989e481..138de9971 100644 --- a/src/jcckit/plot/TicLabelMap.java +++ b/src/jcckit/plot/TicLabelMap.java @@ -43,7 +43,7 @@ import jcckit.util.TicLabelFormat; *

* The second form maps a particular number onto a label. In order to be * equal with the sepcified number the tic value should not deviate more - * than 1 ppm (part per millions) from <number>. + * than 1 ppm (part per millions) from <number>. *

* The third form maps an interval onto a label. The condition reads *

diff --git a/src/jcckit/util/ConfigData.java b/src/jcckit/util/ConfigData.java index 7a48bb395..3ab0d10bf 100644 --- a/src/jcckit/util/ConfigData.java +++ b/src/jcckit/util/ConfigData.java @@ -21,7 +21,7 @@ package jcckit.util; /** * Interface for hierarchically managed key-value pairs. The key is * always a string which contains any kind of printable character except - * '/', '=', ':', and whitespace characters like ' ' and '\t'. + * '/', '=', ':', and whitespace characters like ' ' and '\\t'. * The value is either a string or a ConfigData object. *

* This interface will be used by {@link ConfigParameters} in accordance diff --git a/src/jcckit/util/Format.java b/src/jcckit/util/Format.java index c4e04e2b4..f24c1855a 100644 --- a/src/jcckit/util/Format.java +++ b/src/jcckit/util/Format.java @@ -59,7 +59,7 @@ public class Format implements TicLabelFormat { * Creates an instance for the specified format string. * The format string is an alternation of some static texts and * format elements. - * A format element has to start with '%' and it must end with + * A format element has to start with `%` and it must end with * one of the following format descriptors: * * @@ -77,7 +77,7 @@ public class Format implements TicLabelFormat { * format of logarithmic format depending on the size of * the mantissa. *
d
- * The characters between '%' and the decriptor are optional. + * The characters between `%` and the decriptor are optional. * They can be grouped into *

  • modifier
    * it is @@ -90,7 +90,7 @@ public class Format implements TicLabelFormat { * of the result *
  • precision *
- * A plain '%' is coded as '%%'. + * A plain `%` is coded as `%%`. * @param formatString The format string. * @exception IllegalArgumentException if invalid format string. */ diff --git a/src/net/sourceforge/plantuml/brotli/Utils.java b/src/net/sourceforge/plantuml/brotli/Utils.java index 35034d867..ce52ef225 100644 --- a/src/net/sourceforge/plantuml/brotli/Utils.java +++ b/src/net/sourceforge/plantuml/brotli/Utils.java @@ -25,8 +25,8 @@ final class Utils { * less than 16. * * @param dest array to fill with zeroes - * @param offset the first byte to fill - * @param length number of bytes to change + * @param start the first byte to fill + * @param end the last byte to fill */ static void fillBytesWithZeroes(byte[] dest, int start, int end) { int cursor = start; @@ -44,8 +44,8 @@ final class Utils { * less than 16. * * @param dest array to fill with zeroes - * @param offset the first item to fill - * @param length number of item to change + * @param start the first item to fill + * @param end the last item to fill */ static void fillIntsWithZeroes(int[] dest, int start, int end) { int cursor = start; diff --git a/src/net/sourceforge/plantuml/core/ImageData.java b/src/net/sourceforge/plantuml/core/ImageData.java index 71e33d155..14c961812 100644 --- a/src/net/sourceforge/plantuml/core/ImageData.java +++ b/src/net/sourceforge/plantuml/core/ImageData.java @@ -72,13 +72,13 @@ public interface ImageData { * For example, if you call this method with nameId * set to "foo_map", you will get something like: * - * 
+	 * 
 	 * <map id="foo_map" name="foo_map">
 	 * <area shape="rect" id="..." href="..." title="..." alt="" coords="64,68,93,148"/>
 	 * </map>
-	 * 

+	 * 
 	 * 
-	 * @param nameId thie id to be used in the cmap data string.
+	 * @param nameId the id to be used in the cmap data string.
 	 * @return
 	 */
 	public String getCMapData(String nameId);
diff --git a/src/net/sourceforge/plantuml/swing/ImageHelper.java b/src/net/sourceforge/plantuml/swing/ImageHelper.java
index 24f1d860b..18cb6b023 100644
--- a/src/net/sourceforge/plantuml/swing/ImageHelper.java
+++ b/src/net/sourceforge/plantuml/swing/ImageHelper.java
@@ -55,7 +55,7 @@ public class ImageHelper {
 	 *            the original image to be scaled
 	 * @param targetDim
 	 *            the desired dimensions of the scaled instance, in pixels
-	 * @param hint
+	 * @param hints
 	 *            RenderingHints used when scaling the image
 	 * @param higherQuality
 	 *            if true, this method will use a multi-step scaling technique that provides higher quality than the
diff --git a/src/net/sourceforge/plantuml/zopfli/Cookie.java b/src/net/sourceforge/plantuml/zopfli/Cookie.java
index a26136df7..0ead5f32e 100644
--- a/src/net/sourceforge/plantuml/zopfli/Cookie.java
+++ b/src/net/sourceforge/plantuml/zopfli/Cookie.java
@@ -166,7 +166,7 @@ class Cookie {
 
   /**
    * Maximum amount of blocks to split into.
-   * 

+   * 

    * {@code 0} for unlimited.
    */
   final int blockSplittingMax = 15;
diff --git a/src/org/stathissideris/ascii2image/graphics/Diagram.java b/src/org/stathissideris/ascii2image/graphics/Diagram.java
index c41af73b2..b935c9063 100644
--- a/src/org/stathissideris/ascii2image/graphics/Diagram.java
+++ b/src/org/stathissideris/ascii2image/graphics/Diagram.java
@@ -103,8 +103,8 @@ public class Diagram {
 	 * 
Finally, the text processing occurs: [pending]

 	 * 
 	 * @param grid
-	 * @param cellWidth
-	 * @param cellHeight
+	 * @param options
+	 * @param processingOptions
 	 */
 	public Diagram(TextGrid grid, ConversionOptions options, ProcessingOptions processingOptions) {
 		
diff --git a/src/org/stathissideris/ascii2image/graphics/DiagramShape.java b/src/org/stathissideris/ascii2image/graphics/DiagramShape.java
index 7a151335a..7f6586902 100644
--- a/src/org/stathissideris/ascii2image/graphics/DiagramShape.java
+++ b/src/org/stathissideris/ascii2image/graphics/DiagramShape.java
@@ -532,6 +532,7 @@ public class DiagramShape extends DiagramComponent {
 	 *
 	 * @param pointInCell
 	 * @param otherPoint
+	 * @param diagram
 	 * @return
 	 */
 	public ShapePoint getCellEdgePointBetween(ShapePoint pointInCell, ShapePoint otherPoint, Diagram diagram){
diff --git a/src/org/stathissideris/ascii2image/graphics/ShapeEdge.java b/src/org/stathissideris/ascii2image/graphics/ShapeEdge.java
index c02b35395..6e09d91f6 100644
--- a/src/org/stathissideris/ascii2image/graphics/ShapeEdge.java
+++ b/src/org/stathissideris/ascii2image/graphics/ShapeEdge.java
@@ -106,7 +106,7 @@ public class ShapeEdge {
 
 	/**
 	 * Returns the type of the edge
-	 * (TYPE_HORIZONTAL, TYPE_VERTICAL, TYPE_SLOPED).
+	 * (TYPE_HORIZONTAL, TYPE_VERTICAL, TYPE_SLOPED).
 	 * 
 	 * @return
 	 */
diff --git a/src/org/stathissideris/ascii2image/text/TextGrid.java b/src/org/stathissideris/ascii2image/text/TextGrid.java
index 40a635fe5..42a30ea8f 100644
--- a/src/org/stathissideris/ascii2image/text/TextGrid.java
+++ b/src/org/stathissideris/ascii2image/text/TextGrid.java
@@ -1310,7 +1310,7 @@ public class TextGrid {
 		}
 	}
 
-	/**
+	/*
 	 * 
 	 * Fills the continuous area with if c1 characters with c2,
 	 * flooding from cell x, y