Cover AnnotationDefaultAppearance and PdfAction with documentation

DEVSIX-5332

Author: ars18wrw

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

@@ -709,6 +709,12 @@ private static void validateRemoteDestination(PdfDestination destination) {
         }
     }
 
+    /**
+     * Validates not remote destination against the PDF specification and in case of invalidity logs a warning.
+     * See section 12.3.2.2 of ISO 32000-1.
+     *
+     * @param destination the {@link PdfDestination destination} to be validated
+     */
     public static void validateNotRemoteDestination(PdfDestination destination) {
         if (destination instanceof PdfExplicitRemoteGoToDestination) {
             LoggerFactory.getLogger(PdfAction.class).warn(LogMessageConstant.INVALID_DESTINATION_TYPE);

kernel/src/main/java/com/itextpdf/kernel/pdf/annot/da/AnnotationDefaultAppearance.java

@@ -53,7 +53,16 @@ This file is part of the iText (R) project.
 import java.util.Map;
 
 /**
- * Helper class for setting
+ * Helper class for setting annotation default appearance. The class provides setters for
+ * font color, font size and font itself.
+ *
+ * <p>
+ * Note that only standard font names that do not require font resources are supported.
+ *
+ * <p>
+ * Note that it is possible to create annotation with custom font name in DA, but this require
+ * manual resource modifications (you have to put font in DR of AcroForm and use
+ * its resource name in DA) and only Acrobat supports that workflow.
  */
 public class AnnotationDefaultAppearance {
 
@@ -92,41 +101,93 @@ public class AnnotationDefaultAppearance {
     private String rawFontName = "/Helv";
     private float fontSize = 0;
 
+    /**
+     * Creates the default instance of {@link AnnotationDefaultAppearance}.
+     *
+     * <p>
+     * The default font is {@link StandardAnnotationFont#Helvetica}. The default font size is 12.
+     */
     public AnnotationDefaultAppearance() {
         setFont(StandardAnnotationFont.Helvetica);
         setFontSize(12);
     }
 
+    /**
+     * Sets the {@link AnnotationDefaultAppearance}'s default font.
+     *
+     * @param font one of {@link StandardAnnotationFont standard annotation fonts} to be set as
+     *             the default one for this {@link AnnotationDefaultAppearance}
+     * @return this {@link AnnotationDefaultAppearance}
+     */
     public AnnotationDefaultAppearance setFont(StandardAnnotationFont font) {
         setRawFontName(stdAnnotFontNames.get(font));
         return this;
     }
 
+    /**
+     * Sets the {@link AnnotationDefaultAppearance}'s default font.
+     *
+     * @param font one of {@link ExtendedAnnotationFont extended annotation fonts} to be set as
+     *             the default one for this {@link AnnotationDefaultAppearance}
+     * @return this {@link AnnotationDefaultAppearance}
+     */
     public AnnotationDefaultAppearance setFont(ExtendedAnnotationFont font) {
         setRawFontName(extAnnotFontNames.get(font));
         return this;
     }
 
+    /**
+     * Sets the {@link AnnotationDefaultAppearance}'s default font size.
+     *
+     * @param fontSize font size to be set as the {@link AnnotationDefaultAppearance}'s default font size
+     * @return this {@link AnnotationDefaultAppearance}
+     */
     public AnnotationDefaultAppearance setFontSize(float fontSize) {
         this.fontSize = fontSize;
         return this;
     }
 
+    /**
+     * Sets the {@link AnnotationDefaultAppearance}'s default font color.
+     *
+     * @param rgbColor {@link DeviceRgb} to be set as the {@link AnnotationDefaultAppearance}'s
+     *                                  default font color
+     * @return this {@link AnnotationDefaultAppearance}
+     */
     public AnnotationDefaultAppearance setColor(DeviceRgb rgbColor) {
         setColorOperand(rgbColor.getColorValue(), "rg");
         return this;
     }
 
+    /**
+     * Sets the {@link AnnotationDefaultAppearance}'s default font color.
+     *
+     * @param cmykColor {@link DeviceCmyk} to be set as the {@link AnnotationDefaultAppearance}'s
+     *                                  default font color
+     * @return this {@link AnnotationDefaultAppearance}
+     */
     public AnnotationDefaultAppearance setColor(DeviceCmyk cmykColor) {
         setColorOperand(cmykColor.getColorValue(), "k");
         return this;
     }
 
+    /**
+     * Sets the {@link AnnotationDefaultAppearance}'s default font color.
+     *
+     * @param grayColor {@link DeviceGray} to be set as the {@link AnnotationDefaultAppearance}'s
+     *                                  default font color
+     * @return this {@link AnnotationDefaultAppearance}
+     */
     public AnnotationDefaultAppearance setColor(DeviceGray grayColor) {
         setColorOperand(grayColor.getColorValue(), "g");
         return this;
     }
 
+    /**
+     * Gets the {@link AnnotationDefaultAppearance}'s representation as {@link PdfString}.
+     *
+     * @return the {@link PdfString} representation of this {@link AnnotationDefaultAppearance}
+     */
     public PdfString toPdfString() {
         return new PdfString(MessageFormatUtil.format("{0} {1} Tf {2}", rawFontName, fontSize, colorOperand));
     }