Merge pull request #224 from albert-github/feature/bug_docu

Documentation corrections

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;
 
 /**
- * <h1>AC.earth - XEarth for Java
- * <h1>
+ * <h1>AC.earth - XEarth for Java</h1>
  * 
  * <p>
  * The original XEarth was written by Kirk Johnson in July 1993 - thank you for
@@ -370,4 +369,4 @@ public class ACearth {
 		return fConf;
 	}
 
-}
+}

src/ext/plantuml/com/ctreber/acearth/MapData.java

@@ -4,8 +4,7 @@ import java.util.ArrayList;
 import java.util.List;
 
 /**
- * <h1>AC.earth - XEarth for Java
- * <h1>
+ * <h1>AC.earth - XEarth for Java</h1>
  * 
  * <p>
  * The original XEarth was written by Kirk Johnson in July 1993 - thank you for
@@ -6832,4 +6831,4 @@ public class MapData {
 	}
 
 
-}
+}

src/ext/plantuml/com/ctreber/acearth/MapDataReader.java

@@ -44,8 +44,6 @@ public class MapDataReader {
 	 * <p>
 	 * Read map data.
 	 * 
-	 * @param pFileName
-	 *            Map data file name.
 	 * @return Array of map polygons.
 	 * @throws IOException
 	 */

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)
    */

src/jcckit/GraphicsPlotCanvas.java

@@ -93,7 +93,7 @@ public class GraphicsPlotCanvas extends PlotCanvas {
 	 * <td>Foreground color of the wrapped AWT component.</td>
 	 * </tr>
 	 * <tr>
-	 * <td><tt>doubleBuffering = true</td>
+	 * <td><tt>doubleBuffering = true</tt></td>
 	 *     <td><tt>boolean</tt></td><td>no</td>
 	 *     <td>If <tt>true</tt> the plot will be painted by using 
 	 *         double-buffering and pre-rendered view of the coordinate system.

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. <tt>null</tt> is not allowed.
    * @throws NullPointerException if <tt>element == null</tt>
    */

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 <tt>true</tt> if this polygon is closed.
    */
   public Polygon(GraphicAttributes attributes, boolean closed) {

src/jcckit/graphic/ShapeAttributes.java

@@ -47,7 +47,7 @@ public class ShapeAttributes implements LineAttributes, FillAttributes {
    *     <th>Description</th></tr>
    * <tr><td><tt>fillColor = <i>no filling</i></tt></td><td><tt>Color</tt></td>
    *     <td>no</td><td>The fill color of the shape.</td></tr>
-   * <tr><td><tt>lineColor = <i>no line<i></tt></td><td><tt>Color</tt></td>
+   * <tr><td><tt>lineColor = <i>no line</i></tt></td><td><tt>Color</tt></td>
    *     <td>no</td><td>The color of a line, a polygon, or the border of a shape.</td></tr>
    * <tr><td><tt>lineThickness = 0</tt></td><td><tt>double</tt></td>
    *     <td>no</td>

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}.

src/jcckit/plot/SimpleCurveFactory.java

@@ -42,8 +42,8 @@ public class SimpleCurveFactory implements CurveFactory {
    * <table border=1 cellpadding=5>
    * <tr><th>Key &amp; Default Value</th><th>Type</th><th>Mandatory</th>
    *     <th>Description</th></tr>
-   * <tr><td><tt>definitions = </tt><i>one empty <tt>ConfigParameters<tt> 
-   *         instance</i></td>
+   * <tr><td><tt>definitions = </tt><i>one empty</i> <tt>ConfigParameters</tt> 
+   *         <i>instance</i></td>
    *     <td><tt>String[]</tt></td><td>no</td>
    *     <td>Keys of subtrees defining {@link ConfigParameters}
    *         used by the {@link SimpleCurve#SimpleCurve constructor} of 

src/jcckit/plot/TicLabelMap.java

@@ -43,7 +43,7 @@ import jcckit.util.TicLabelFormat;
  * <p>
  * 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 <tt><i>&lt;number&gt;</i>.
+ * than 1 ppm (part per millions) from <tt><i>&lt;number&gt;</i></tt>.
  * <p>
  * The third form maps an interval onto a label. The condition reads
  * <p>

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 <tt>ConfigData</tt> object.
  *  <p>
  *  This interface will be used by {@link ConfigParameters} in accordance

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:
    *  <table border=0 cellpadding=5>
    *    <tr><td><tt>d</tt></td>
@@ -77,7 +77,7 @@ public class Format implements TicLabelFormat {
    *            format of logarithmic format depending on the size of
    *            the mantissa.</td></tr>
    *  </table>
-   *  The characters between '%' and the decriptor are optional.
+   *  The characters between `%` and the decriptor are optional.
    *  They can be grouped into
    *  <ul><li>modifier<br>
    *          it is
@@ -90,7 +90,7 @@ public class Format implements TicLabelFormat {
    *          of the result
    *      <li>precision
    *  </ul>
-   *  A plain '%' is coded as '%%'.
+   *  A plain `%` is coded as `%%`.
    *  @param formatString The format string.
    *  @exception IllegalArgumentException if invalid format string.
    */

src/net/sourceforge/plantuml/brotli/Utils.java

@@ -27,8 +27,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;
@@ -46,8 +46,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;

src/net/sourceforge/plantuml/core/ImageData.java

@@ -72,13 +72,13 @@ public interface ImageData {
 	 * For example, if you call this method with <code>nameId</code>
 	 * set to "foo_map", you will get something like:
 	 * 
-	 * <code><pre>
+	 * <pre>
 	 * &lt;map id="foo_map" name="foo_map"&gt;
 	 * &lt;area shape="rect" id="..." href="..." title="..." alt="" coords="64,68,93,148"/&gt;
 	 * &lt;/map&gt;
-	 * </pre></code>
+	 * </code>
 	 * 
-	 * @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);

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

src/net/sourceforge/plantuml/zopfli/Cookie.java

@@ -166,7 +166,7 @@ class Cookie {
 
   /**
    * Maximum amount of blocks to split into.
-   * <p/>
+   * <p>
    * {@code 0} for unlimited.
    */
   final int blockSplittingMax = 15;

src/org/stathissideris/ascii2image/graphics/Diagram.java

@@ -103,8 +103,8 @@ public class Diagram {
 	 * <p>Finally, the text processing occurs: [pending]</p>
 	 * 
 	 * @param grid
-	 * @param cellWidth
-	 * @param cellHeight
+	 * @param options
+	 * @param processingOptions
 	 */
 	public Diagram(TextGrid grid, ConversionOptions options, ProcessingOptions processingOptions) {
 		

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){

src/org/stathissideris/ascii2image/graphics/ShapeEdge.java

@@ -106,7 +106,7 @@ public class ShapeEdge {
 
 	/**
 	 * Returns the type of the edge
-	 * (<code>TYPE_HORIZONTAL, TYPE_VERTICAL, TYPE_SLOPED).
+	 * (<code>TYPE_HORIZONTAL, TYPE_VERTICAL, TYPE_SLOPED</code>).
 	 * 
 	 * @return
 	 */

src/org/stathissideris/ascii2image/text/TextGrid.java

@@ -1292,7 +1292,7 @@ public class TextGrid {
 		}
 	}
 
-	/**
+	/*
 	 * 
 	 * Fills the continuous area with if c1 characters with c2,
 	 * flooding from cell x, y