🚨 Fix javadoc warnings

DEVSIX-1287

Author: amedee

io/src/main/java/com/itextpdf/io/IOException.java

@@ -136,7 +136,7 @@ public class IOException extends RuntimeException {
     public static final String NotAtTrueTypeFile = "{0} is not a true type file";
     public static final String PageNumberMustBeGtEq1 = "Page number must be >= 1.";
     /**
-     * @deprecated because naming clash with {@link com itextpdf io font PdfEncodings}
+     * @deprecated because naming clash with {@link com.itextpdf.io.font.PdfEncodings}
      * may produce confusion with imports  Superseded by {@link #CharacterCodeException}
      */
     @Deprecated

io/src/main/java/com/itextpdf/io/font/OpenTypeParser.java

@@ -152,14 +152,14 @@ protected static class CmapTable implements Serializable {
          * The map containing the code information for the table 'cmap', encoding 1.0.
          * The key is the code and the value is an {@code int[2]} where position 0
          * is the glyph number and position 1 is the glyph width normalized to 1000 units.
-         * {@see TrueTypeFont.UNITS_NORMALIZATION}.
+         * @see TrueTypeFont#UNITS_NORMALIZATION
          */
         Map<Integer, int[]> cmap10;
         /**
          * The map containing the code information for the table 'cmap', encoding 3.1 in Unicode.
          * The key is the code and the value is an {@code int[2]} where position 0
          * is the glyph number and position 1 is the glyph width normalized to 1000 units.
-         * {@see TrueTypeFont.UNITS_NORMALIZATION}.
+         * @see TrueTypeFont#UNITS_NORMALIZATION
          */
         Map<Integer, int[]> cmap31;
         Map<Integer, int[]> cmapExt;

io/src/main/java/com/itextpdf/io/font/otf/Glyph.java

@@ -309,7 +309,7 @@ public boolean equals(Object obj) {
 
     /**
      * Gets a Unicode string corresponding to this glyph. In general case it might consist of many characters.
-     * If this glyph does not have a valid unicode ({@see #hasValidUnicode()}, then a string consisting of a special
+     * If this glyph does not have a valid unicode ({@link #hasValidUnicode()}), then a string consisting of a special
      * Unicode '\ufffd' character is returned.
      * @return the Unicode string that corresponds to this glyph
      */
@@ -323,7 +323,8 @@ public String getUnicodeString() {
 
     /**
      * Gets Unicode char sequence corresponding to this glyph. In general case it might consist of many characters.
-     * If this glyph does not have a valid unicode ({@see #hasValidUnicode()}, then a special Unicode '\ufffd' character is returned.
+     * If this glyph does not have a valid unicode ({@link #hasValidUnicode()}), then a special
+     * Unicode '\ufffd' character is returned.
      * @return the Unicode char sequence that corresponds to this glyph
      */
     public char[] getUnicodeChars() {

io/src/main/java/com/itextpdf/io/source/PdfTokenizer.java

@@ -632,7 +632,7 @@ protected static boolean isDelimiterWhitespace(int ch) {
      * Helper method to handle content errors. Add file position to {@code PdfRuntimeException}.
      * @param error message.
      * @param messageParams error params.
-     * @wrap error message into {@code PdfRuntimeException} and add position in file.
+     * @throws IOException wrap error message into {@code PdfRuntimeException} and add position in file.
      */
     public void throwError(String error, Object... messageParams) {
         try {

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

@@ -104,7 +104,7 @@ protected PdfFont() {
      * Get glyph by unicode
      *
      * @param unicode a unicode code point
-     * @return {@see Glyph} if it exists or .NOTDEF if supported, otherwise {@code null}.
+     * @return {@link Glyph} if it exists or .NOTDEF if supported, otherwise {@code null}.
      */
     public abstract Glyph getGlyph(int unicode);
 

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

@@ -1828,7 +1828,7 @@ protected XMPMeta updateDefaultXmpMetadata() throws XMPException {
     /**
      * List all newly added or loaded fonts
      *
-     * @return List of {@see PdfFonts}.
+     * @return List of {@link PdfFont}.
      */
     protected Collection<PdfFont> getDocumentFonts() {
         return documentFonts.values();

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

@@ -661,7 +661,7 @@ public Rectangle getTrimBox() {
      * Get decoded bytes for the whole page content.
      *
      * @return byte array.
-     * @throws PdfException in case of any {@link IOException).
+     * @throws PdfException in case of any {@link IOException}.
      */
     public byte[] getContentBytes() {
         try {
@@ -686,7 +686,7 @@ public byte[] getContentBytes() {
      *
      * @param index index of stream inside Content.
      * @return byte array.
-     * @throws PdfException in case of any {@link IOException).
+     * @throws PdfException in case of any {@link IOException}.
      */
     public byte[] getStreamBytes(int index) {
         return getContentStream(index).getBytes();
@@ -736,7 +736,7 @@ public PdfPage setAdditionalAction(PdfName key, PdfAction action) {
      * Gets array of annotation dictionaries that shall contain indirect references
      * to all annotations associated with the page.
      *
-     * @return the {@link List<PdfAnnotation>} containing all page's annotations.
+     * @return the {@link List}&lt;{@link PdfAnnotation}&gt; containing all page's annotations.
      */
     public List<PdfAnnotation> getAnnotations() {
         List<PdfAnnotation> annotations = new ArrayList<>();

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

@@ -44,16 +44,15 @@ This file is part of the iText (R) project.
 package com.itextpdf.kernel.pdf;
 
 import com.itextpdf.io.LogMessageConstant;
-import com.itextpdf.kernel.PdfException;
 import com.itextpdf.io.source.ByteArrayOutputStream;
+import com.itextpdf.kernel.PdfException;
+import org.slf4j.LoggerFactory;
 
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.ObjectOutputStream;
 import java.io.Serializable;
 
-import org.slf4j.LoggerFactory;
-
 /**
  * Representation of a stream as described in the PDF Specification.
  */
@@ -71,7 +70,7 @@ public class PdfStream extends PdfDictionary {
     /**
      * Constructs a {@code PdfStream}-object.
      *
-     * @param bytes            initial content of {@see PdfOutputStream}.
+     * @param bytes            initial content of {@link PdfOutputStream}.
      * @param compressionLevel the compression level (0 = best speed, 9 = best compression, -1 is default)
      */
     public PdfStream(byte[] bytes, int compressionLevel) {
@@ -401,7 +400,8 @@ protected long getOffset() {
     }
 
     /**
-     * Update length manually in case its correction. {@see PdfReader.checkPdfStreamLength()} method.
+     * Update length manually in case its correction.
+     * @see com.itextpdf.kernel.pdf.PdfReader#checkPdfStreamLength(PdfStream)
      */
     protected void updateLength(int length) {
         this.length = length;

kernel/src/main/java/com/itextpdf/kernel/pdf/action/PdfAction.java

@@ -585,7 +585,7 @@ public static PdfAction createResetForm(Object[] names, int flags) {
     }
 
     /**
-     * Adds an additional action to the provided {@link PdfObjectWrapper<PdfDictionary>} wrapper.
+     * Adds an additional action to the provided {@link PdfObjectWrapper}&lt;{@link PdfDictionary}&gt; wrapper.
      *
      * @param wrapper the wrapper to add an additional action to
      * @param key     a {@link PdfName} specifying the name of an additional action

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

@@ -370,7 +370,7 @@ public PdfAnnotation setAction(PdfAction action) {
 
     /**
      * Sets an additional {@link PdfAction} to this annotation which will be performed in response to
-     * the specific trigger event defined by {@param key}. See ISO-320001 12.6.3, "Trigger Events".
+     * the specific trigger event defined by {@code key}. See ISO-320001 12.6.3, "Trigger Events".
      * @param key a {@link PdfName} that denotes a type of the additional action to set.
      * @param action {@link PdfAction} to set as additional to this annotation.
      * @return this {@link PdfAnnotation} instance.