Fix javadocs in order in order to make them portable to C# code documentation

Also remove </li> and </dt>, </dd> from javadocs in kernel module. In javadocs it's enough to specify only openning tags and we aim at less cluttered documentation.

DEVSIX-3096

Author: yulian-gaponenko

kernel/src/main/java/com/itextpdf/kernel/font/PdfFont.java

@@ -376,8 +376,8 @@ public boolean isSubset() {
 
     /**
      * Indicates if all the glyphs and widths for that particular
-     * encoding should be included in the document. When set to <CODE>true</CODE>
-     * only the glyphs used will be included in the font. When set to <CODE>false</CODE
+     * encoding should be included in the document. When set to {@code true}
+     * only the glyphs used will be included in the font. When set to {@code false}
      * the full font will be included and all subset ranges will be removed.
      *
      * @param subset new value of property subset

kernel/src/main/java/com/itextpdf/kernel/geom/AffineTransform.java

@@ -186,14 +186,14 @@ public AffineTransform(double[] matrix) {
      * translation vector is (m02, m12). Original basis vectors are (1, 0) and (0, 1).
      * Type transformations classification:
      * <ul>
-     * <li>{@link AffineTransform#TYPE_IDENTITY} - new basis equals original one and zero translation</li>
-     * <li>{@link AffineTransform#TYPE_TRANSLATION} - translation vector isn't zero</li>
-     * <li>{@link AffineTransform#TYPE_UNIFORM_SCALE} - vectors length of new basis equals</li>
-     * <li>{@link AffineTransform#TYPE_GENERAL_SCALE} - vectors length of new basis doesn't equal</li>
-     * <li>{@link AffineTransform#TYPE_FLIP} - new basis vector orientation differ from original one</li>
-     * <li>{@link AffineTransform#TYPE_QUADRANT_ROTATION} - new basis is rotated by 90, 180, 270, or 360 degrees</li>
-     * <li>{@link AffineTransform#TYPE_GENERAL_ROTATION} - new basis is rotated by arbitrary angle</li>
-     * <li>{@link AffineTransform#TYPE_GENERAL_TRANSFORM} - transformation can't be inversed</li>
+     * <li>{@link AffineTransform#TYPE_IDENTITY} - new basis equals original one and zero translation
+     * <li>{@link AffineTransform#TYPE_TRANSLATION} - translation vector isn't zero
+     * <li>{@link AffineTransform#TYPE_UNIFORM_SCALE} - vectors length of new basis equals
+     * <li>{@link AffineTransform#TYPE_GENERAL_SCALE} - vectors length of new basis doesn't equal
+     * <li>{@link AffineTransform#TYPE_FLIP} - new basis vector orientation differ from original one
+     * <li>{@link AffineTransform#TYPE_QUADRANT_ROTATION} - new basis is rotated by 90, 180, 270, or 360 degrees
+     * <li>{@link AffineTransform#TYPE_GENERAL_ROTATION} - new basis is rotated by arbitrary angle
+     * <li>{@link AffineTransform#TYPE_GENERAL_TRANSFORM} - transformation can't be inversed
      * </ul>
      *
      * @return the type of this AffineTransform
@@ -384,7 +384,7 @@ public void setToRotation(double angle) {
     /**
      * Set this affine transformation to represent a rotation over the passed angle,
      * using the passed point as the center of rotation
-     * 
+     *
      * @param angle angle to rotate over in radians
      * @param px x-coordinate of center of rotation
      * @param py y-coordinate of center of rotation

kernel/src/main/java/com/itextpdf/kernel/pdf/PdfDate.java

@@ -49,13 +49,13 @@ This file is part of the iText (R) project.
 
 /**
  * {@code PdfDate} is the PDF date object.
- * <P>
+ * <p>
  * PDF defines a standard date format. The PDF date format closely follows the format
  * defined by the international standard ASN.1 (Abstract Syntax Notation One, defined
  * in CCITT X.208 or ISO/IEC 8824). A date is a {@code PdfString} of the form:
- * <P><BLOCKQUOTE>
- * (D:YYYYMMDDHHmmSSOHH'mm')
- * </BLOCKQUOTE><P>
+ * <p>
+ * {@code (D:YYYYMMDDHHmmSSOHH'mm') }
+ * <p>
  * See also ISO-320001 7.9.4, "Dates".
  *
  * @see PdfString

kernel/src/main/java/com/itextpdf/kernel/pdf/PdfObject.java

@@ -534,12 +534,12 @@ protected void copyContent(PdfObject from, PdfDocument document) {
     /**
      * Processes two cases of object copying:
      * <ol>
-     * <li>copying to the other document</li>
-     * <li>cloning inside of the current document</li>
+     * <li>copying to the other document
+     * <li>cloning inside of the current document
      * </ol>
      * <p>
-     * This two cases are distinguished by the state of <code>document</code> parameter:
-     * the second case is processed if <code>document</code> is <code>null</code>.
+     * This two cases are distinguished by the state of {@code document} parameter:
+     * the second case is processed if {@code document} is {@code null}.
      *
      * @param documentTo       if not null: document to copy object to; otherwise indicates that object is to be cloned.
      * @param allowDuplicating indicates if to allow copy objects which already have been copied.

kernel/src/main/java/com/itextpdf/kernel/pdf/PdfString.java

@@ -62,8 +62,7 @@ This file is part of the iText (R) project.
  * way to represent characters outside the printable ASCII character set.<br>
  * This object is described in the 'Portable Document Format Reference Manual
  * version 1.7' section 3.2.3 (page 53-56).
- * <p>
- * {@link PdfObject}
+ * @see PdfObject
  */
 public class PdfString extends PdfPrimitiveObject {
 

kernel/src/main/java/com/itextpdf/kernel/pdf/PdfTextArray.java

@@ -44,23 +44,24 @@ This file is part of the iText (R) project.
 package com.itextpdf.kernel.pdf;
 
 import com.itextpdf.kernel.font.PdfFont;
+import com.itextpdf.kernel.pdf.canvas.PdfCanvas;
 import java.util.Collection;
 
 /**
- * <CODE>PdfTextArray</CODE> defines an array with displacements and <CODE>PdfString</CODE>-objects.
+ * {@link PdfTextArray} defines an array with displacements and {@link PdfString}-objects.
  * <P>
- * A <CODE>PdfTextArray</CODE> is used with the operator <VAR>TJ</VAR> in <CODE>PdfCanvas</CODE>.
- * The first object in this array has to be a <CODE>PdfString</CODE>;
+ * A {@link PdfTextArray} is used with the operator TJ in {@link PdfCanvas}.
+ * The first object in this array has to be a {@link PdfString};
  * see reference manual version 1.3 section 8.7.5, pages 346-347.
  *       OR
  * see reference manual version 1.6 section 5.3.2, pages 378-379.
  * To emit a more efficient array, we consolidate repeated numbers or strings into single array entries.
- * "add( 50 ); add( -50 );" will REMOVE the combined zero from the array.
+ * For example: "add( 50 ); add( -50 );" will REMOVE the combined zero from the array.
  */
 public class PdfTextArray extends PdfArray {
 
     private static final long serialVersionUID = 2555632135770071680L;
-	
+
     private float lastNumber = Float.NaN;
     private StringBuilder lastString;
 

kernel/src/main/java/com/itextpdf/kernel/pdf/WriterProperties.java

@@ -157,14 +157,14 @@ public WriterProperties setFullCompressionMode(boolean fullCompressionMode) {
      * {@link EncryptionConstants#ALLOW_FILL_IN}, {@link EncryptionConstants#ALLOW_SCREENREADERS},
      * {@link EncryptionConstants#ALLOW_ASSEMBLY} and {@link EncryptionConstants#ALLOW_DEGRADED_PRINTING}.
      * The permissions can be combined by ORing them.
-     * <p>
+     *
      * @param userPassword        the user password. Can be null or empty
      * @param ownerPassword       the owner password. Can be null or empty
      * @param permissions         the user permissions
      * @param encryptionAlgorithm the type of encryption. It can be one of {@link EncryptionConstants#STANDARD_ENCRYPTION_40},
-     * {@link EncryptionConstants#STANDARD_ENCRYPTION_128}, {@link EncryptionConstants#ENCRYPTION_AES_128}
-     *                       or {@link EncryptionConstants#ENCRYPTION_AES_256}.
-     *                       Optionally {@link EncryptionConstants#DO_NOT_ENCRYPT_METADATA} can be ORed to output the metadata in cleartext
+     *                            {@link EncryptionConstants#STANDARD_ENCRYPTION_128}, {@link EncryptionConstants#ENCRYPTION_AES_128}
+     *                            or {@link EncryptionConstants#ENCRYPTION_AES_256}.
+     *                            Optionally {@link EncryptionConstants#DO_NOT_ENCRYPT_METADATA} can be ORed to output the metadata in cleartext
      * @return this {@code WriterProperties} instance
      */
     public WriterProperties setStandardEncryption(byte[] userPassword, byte[] ownerPassword, int permissions, int encryptionAlgorithm) {
@@ -181,13 +181,13 @@ public WriterProperties setStandardEncryption(byte[] userPassword, byte[] ownerP
      * {@link EncryptionConstants#ALLOW_FILL_IN}, {@link EncryptionConstants#ALLOW_SCREENREADERS},
      * {@link EncryptionConstants#ALLOW_ASSEMBLY} and {@link EncryptionConstants#ALLOW_DEGRADED_PRINTING}.
      * The permissions can be combined by ORing them.
-     * <p>
+     *
      * @param certs               the public certificates to be used for the encryption
      * @param permissions         the user permissions for each of the certificates
      * @param encryptionAlgorithm the type of encryption. It can be one of {@link EncryptionConstants#STANDARD_ENCRYPTION_40},
-     * {@link EncryptionConstants#STANDARD_ENCRYPTION_128}, {@link EncryptionConstants#ENCRYPTION_AES_128}
-     *                       or {@link EncryptionConstants#ENCRYPTION_AES_256}.
-     *                       Optionally {@link EncryptionConstants#DO_NOT_ENCRYPT_METADATA} can be ORed to output the metadata in cleartext
+     *                            {@link EncryptionConstants#STANDARD_ENCRYPTION_128}, {@link EncryptionConstants#ENCRYPTION_AES_128}
+     *                            or {@link EncryptionConstants#ENCRYPTION_AES_256}.
+     *                            Optionally {@link EncryptionConstants#DO_NOT_ENCRYPT_METADATA} can be ORed to output the metadata in cleartext
      * @return this {@code WriterProperties} instance
      */
     public WriterProperties setPublicKeyEncryption(Certificate[] certs, int[] permissions, int encryptionAlgorithm) {

kernel/src/main/java/com/itextpdf/kernel/pdf/annot/BorderStyleUtil.java

@@ -54,11 +54,11 @@ private BorderStyleUtil(){
     /**
      * Setter for the border style. Possible values are
      * <ul>
-     *     <li>{@link PdfAnnotation#STYLE_SOLID} - A solid rectangle surrounding the annotation.</li>
-     *     <li>{@link PdfAnnotation#STYLE_DASHED} - A dashed rectangle surrounding the annotation.</li>
-     *     <li>{@link PdfAnnotation#STYLE_BEVELED} - A simulated embossed rectangle that appears to be raised above the surface of the page.</li>
-     *     <li>{@link PdfAnnotation#STYLE_INSET} - A simulated engraved rectangle that appears to be recessed below the surface of the page.</li>
-     *     <li>{@link PdfAnnotation#STYLE_UNDERLINE} - A single line along the bottom of the annotation rectangle.</li>
+     *     <li>{@link PdfAnnotation#STYLE_SOLID} - A solid rectangle surrounding the annotation.
+     *     <li>{@link PdfAnnotation#STYLE_DASHED} - A dashed rectangle surrounding the annotation.
+     *     <li>{@link PdfAnnotation#STYLE_BEVELED} - A simulated embossed rectangle that appears to be raised above the surface of the page.
+     *     <li>{@link PdfAnnotation#STYLE_INSET} - A simulated engraved rectangle that appears to be recessed below the surface of the page.
+     *     <li>{@link PdfAnnotation#STYLE_UNDERLINE} - A single line along the bottom of the annotation rectangle.
      * </ul>
      * See also ISO-320001, Table 166.
      * @param bs original border style dictionary.

kernel/src/main/java/com/itextpdf/kernel/pdf/annot/PdfAnnotation.java

@@ -510,39 +510,39 @@ public PdfAnnotation setFlags(int flags) {
      * <li>{@link PdfAnnotation#INVISIBLE} - If set, do not display the annotation if it does not belong to one of the
      * standard annotation types and no annotation handler is available. If clear, display such unknown annotation
      * using an appearance stream specified by its appearance dictionary, if any.
-     * </li>
+     *
      * <li>{@link PdfAnnotation#HIDDEN} - If set, do not display or print the annotation or allow it to interact with
      * the user, regardless of its annotation type or whether an annotation handler is available.
-     * </li>
+     *
      * <li>{@link PdfAnnotation#PRINT} - If set, print the annotation when the page is printed. If clear, never print
      * the annotation, regardless of whether it is displayed on the screen.
-     * </li>
+     *
      * <li>{@link PdfAnnotation#NO_ZOOM} - If set, do not scale the annotation’s appearance to match the magnification of
      * the page. The location of the annotation on the page (defined by the upper-left corner of its annotation
      * rectangle) shall remain fixed, regardless of the page magnification.}
-     * </li>
+     *
      * <li>{@link PdfAnnotation#NO_ROTATE} - If set, do not rotate the annotation’s appearance to match the rotation
      * of the page. The upper-left corner of the annotation rectangle shall remain in a fixed location on the page,
      * regardless of the page rotation.
-     * </li>
+     *
      * <li>{@link PdfAnnotation#NO_VIEW} - If set, do not display the annotation on the screen or allow it to interact
      * with the user. The annotation may be printed (depending on the setting of the Print flag) but should be considered
      * hidden for purposes of on-screen display and user interaction.
-     * </li>
+     *
      * <li>{@link PdfAnnotation#READ_ONLY} -  If set, do not allow the annotation to interact with the user. The annotation
      * may be displayed or printed (depending on the settings of the NoView and Print flags) but should not respond to mouse
      * clicks or change its appearance in response to mouse motions.
-     * </li>
+     *
      * <li>{@link PdfAnnotation#LOCKED} -  If set, do not allow the annotation to be deleted or its properties
      * (including position and size) to be modified by the user. However, this flag does not restrict changes to
      * the annotation’s contents, such as the value of a form field.
-     * </li>
+     *
      * <li>{@link PdfAnnotation#TOGGLE_NO_VIEW} - If set, invert the interpretation of the NoView flag for certain events.
-     * </li>
+     *
      * <li>{@link PdfAnnotation#LOCKED_CONTENTS} - If set, do not allow the contents of the annotation to be modified
      * by the user. This flag does not restrict deletion of the annotation or changes to other annotation properties,
      * such as position and size.
-     * </li>
+     *
      * </ul>
      *
      * @param flag - an integer interpreted as set of one-bit flags which will be enabled for this annotation.
@@ -780,7 +780,6 @@ public PdfAnnotation setAppearanceState(PdfName as) {
     }
 
     /**
-     * <p>
      * An array specifying the characteristics of the annotation’s border.
      * The array consists of three numbers defining the horizontal corner radius,
      * vertical corner radius, and border width, all in default user space units.
@@ -820,16 +819,16 @@ public PdfAnnotation setBorder(PdfArray border) {
     /**
      * An array of numbers in the range 0.0 to 1.0, representing a colour used for the following purposes:
      * <ul>
-     * <li>The background of the annotation’s icon when closed</li>
-     * <li>The title bar of the annotation’s pop-up window</li>
-     * <li>The border of a link annotation</li>
+     * <li>The background of the annotation’s icon when closed
+     * <li>The title bar of the annotation’s pop-up window
+     * <li>The border of a link annotation
      * </ul>
      * The number of array elements determines the colour space in which the colour shall be defined:
      * <ul>
-     * <li>0 - No colour; transparent</li>
-     * <li>1 - DeviceGray</li>
-     * <li>3 - DeviceRGB</li>
-     * <li>4 - DeviceCMYK</li>
+     * <li>0 - No colour; transparent
+     * <li>1 - DeviceGray
+     * <li>3 - DeviceRGB
+     * <li>4 - DeviceCMYK
      * </ul>
      *
      * @return An array of numbers in the range 0.0 to 1.0, representing an annotation colour.

kernel/src/main/java/com/itextpdf/kernel/pdf/annot/PdfCircleAnnotation.java

@@ -99,11 +99,11 @@ public PdfCircleAnnotation setBorderStyle(PdfDictionary borderStyle) {
     /**
      * Setter for the annotation's preset border style. Possible values are
      * <ul>
-     *     <li>{@link PdfAnnotation#STYLE_SOLID} - A solid rectangle surrounding the annotation.</li>
-     *     <li>{@link PdfAnnotation#STYLE_DASHED} - A dashed rectangle surrounding the annotation.</li>
-     *     <li>{@link PdfAnnotation#STYLE_BEVELED} - A simulated embossed rectangle that appears to be raised above the surface of the page.</li>
-     *     <li>{@link PdfAnnotation#STYLE_INSET} - A simulated engraved rectangle that appears to be recessed below the surface of the page.</li>
-     *     <li>{@link PdfAnnotation#STYLE_UNDERLINE} - A single line along the bottom of the annotation rectangle.</li>
+     *     <li>{@link PdfAnnotation#STYLE_SOLID} - A solid rectangle surrounding the annotation.
+     *     <li>{@link PdfAnnotation#STYLE_DASHED} - A dashed rectangle surrounding the annotation.
+     *     <li>{@link PdfAnnotation#STYLE_BEVELED} - A simulated embossed rectangle that appears to be raised above the surface of the page.
+     *     <li>{@link PdfAnnotation#STYLE_INSET} - A simulated engraved rectangle that appears to be recessed below the surface of the page.
+     *     <li>{@link PdfAnnotation#STYLE_UNDERLINE} - A single line along the bottom of the annotation rectangle.
      * </ul>
      * See also ISO-320001, Table 166.
      * @param style The new value for the annotation's border style.