Cover AnnotationDefaultAppearance and PdfAction with documentation

DEVSIX-5332

Autoported commit.
Original commit hash: [685ed690c]

Author: ars18wrw

itext/itext.kernel/itext/kernel/pdf/action/PdfAction.cs

@@ -729,6 +729,17 @@ private static void ValidateRemoteDestination(PdfDestination destination) {
             }
         }
 
+        /// <summary>Validates not remote destination against the PDF specification and in case of invalidity logs a warning.
+        ///     </summary>
+        /// <remarks>
+        /// 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.
+        /// </remarks>
+        /// <param name="destination">
+        /// the
+        /// <see cref="iText.Kernel.Pdf.Navigation.PdfDestination">destination</see>
+        /// to be validated
+        /// </param>
         public static void ValidateNotRemoteDestination(PdfDestination destination) {
             if (destination is PdfExplicitRemoteGoToDestination) {
                 LogManager.GetLogger(typeof(iText.Kernel.Pdf.Action.PdfAction)).Warn(iText.IO.LogMessageConstant.INVALID_DESTINATION_TYPE

itext/itext.kernel/itext/kernel/pdf/annot/da/AnnotationDefaultAppearance.cs

@@ -49,7 +49,17 @@ source product.
 using iText.Kernel.Pdf;
 
 namespace iText.Kernel.Pdf.Annot.DA {
-    /// <summary>Helper class for setting</summary>
+    /// <summary>Helper class for setting annotation default appearance.</summary>
+    /// <remarks>
+    /// Helper class for setting annotation default appearance. The class provides setters for
+    /// font color, font size and font itself.
+    /// <para />
+    /// Note that only standard font names that do not require font resources are supported.
+    /// <para />
+    /// 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.
+    /// </remarks>
     public class AnnotationDefaultAppearance {
         private static readonly IDictionary<StandardAnnotationFont, String> stdAnnotFontNames = new Dictionary<StandardAnnotationFont
             , String>();
@@ -92,41 +102,162 @@ static AnnotationDefaultAppearance() {
 
         private float fontSize = 0;
 
+        /// <summary>
+        /// Creates the default instance of
+        /// <see cref="AnnotationDefaultAppearance"/>.
+        /// </summary>
+        /// <remarks>
+        /// Creates the default instance of
+        /// <see cref="AnnotationDefaultAppearance"/>.
+        /// <para />
+        /// The default font is
+        /// <see cref="StandardAnnotationFont.Helvetica"/>
+        /// . The default font size is 12.
+        /// </remarks>
         public AnnotationDefaultAppearance() {
             SetFont(StandardAnnotationFont.Helvetica);
             SetFontSize(12);
         }
 
+        /// <summary>
+        /// Sets the
+        /// <see cref="AnnotationDefaultAppearance"/>
+        /// 's default font.
+        /// </summary>
+        /// <param name="font">
+        /// one of
+        /// <see cref="StandardAnnotationFont">standard annotation fonts</see>
+        /// to be set as
+        /// the default one for this
+        /// <see cref="AnnotationDefaultAppearance"/>
+        /// </param>
+        /// <returns>
+        /// this
+        /// <see cref="AnnotationDefaultAppearance"/>
+        /// </returns>
         public virtual iText.Kernel.Pdf.Annot.DA.AnnotationDefaultAppearance SetFont(StandardAnnotationFont font) {
             SetRawFontName(stdAnnotFontNames.Get(font));
             return this;
         }
 
+        /// <summary>
+        /// Sets the
+        /// <see cref="AnnotationDefaultAppearance"/>
+        /// 's default font.
+        /// </summary>
+        /// <param name="font">
+        /// one of
+        /// <see cref="ExtendedAnnotationFont">extended annotation fonts</see>
+        /// to be set as
+        /// the default one for this
+        /// <see cref="AnnotationDefaultAppearance"/>
+        /// </param>
+        /// <returns>
+        /// this
+        /// <see cref="AnnotationDefaultAppearance"/>
+        /// </returns>
         public virtual iText.Kernel.Pdf.Annot.DA.AnnotationDefaultAppearance SetFont(ExtendedAnnotationFont font) {
             SetRawFontName(extAnnotFontNames.Get(font));
             return this;
         }
 
+        /// <summary>
+        /// Sets the
+        /// <see cref="AnnotationDefaultAppearance"/>
+        /// 's default font size.
+        /// </summary>
+        /// <param name="fontSize">
+        /// font size to be set as the
+        /// <see cref="AnnotationDefaultAppearance"/>
+        /// 's default font size
+        /// </param>
+        /// <returns>
+        /// this
+        /// <see cref="AnnotationDefaultAppearance"/>
+        /// </returns>
         public virtual iText.Kernel.Pdf.Annot.DA.AnnotationDefaultAppearance SetFontSize(float fontSize) {
             this.fontSize = fontSize;
             return this;
         }
 
+        /// <summary>
+        /// Sets the
+        /// <see cref="AnnotationDefaultAppearance"/>
+        /// 's default font color.
+        /// </summary>
+        /// <param name="rgbColor">
+        /// 
+        /// <see cref="iText.Kernel.Colors.DeviceRgb"/>
+        /// to be set as the
+        /// <see cref="AnnotationDefaultAppearance"/>
+        /// 's
+        /// default font color
+        /// </param>
+        /// <returns>
+        /// this
+        /// <see cref="AnnotationDefaultAppearance"/>
+        /// </returns>
         public virtual iText.Kernel.Pdf.Annot.DA.AnnotationDefaultAppearance SetColor(DeviceRgb rgbColor) {
             SetColorOperand(rgbColor.GetColorValue(), "rg");
             return this;
         }
 
+        /// <summary>
+        /// Sets the
+        /// <see cref="AnnotationDefaultAppearance"/>
+        /// 's default font color.
+        /// </summary>
+        /// <param name="cmykColor">
+        /// 
+        /// <see cref="iText.Kernel.Colors.DeviceCmyk"/>
+        /// to be set as the
+        /// <see cref="AnnotationDefaultAppearance"/>
+        /// 's
+        /// default font color
+        /// </param>
+        /// <returns>
+        /// this
+        /// <see cref="AnnotationDefaultAppearance"/>
+        /// </returns>
         public virtual iText.Kernel.Pdf.Annot.DA.AnnotationDefaultAppearance SetColor(DeviceCmyk cmykColor) {
             SetColorOperand(cmykColor.GetColorValue(), "k");
             return this;
         }
 
+        /// <summary>
+        /// Sets the
+        /// <see cref="AnnotationDefaultAppearance"/>
+        /// 's default font color.
+        /// </summary>
+        /// <param name="grayColor">
+        /// 
+        /// <see cref="iText.Kernel.Colors.DeviceGray"/>
+        /// to be set as the
+        /// <see cref="AnnotationDefaultAppearance"/>
+        /// 's
+        /// default font color
+        /// </param>
+        /// <returns>
+        /// this
+        /// <see cref="AnnotationDefaultAppearance"/>
+        /// </returns>
         public virtual iText.Kernel.Pdf.Annot.DA.AnnotationDefaultAppearance SetColor(DeviceGray grayColor) {
             SetColorOperand(grayColor.GetColorValue(), "g");
             return this;
         }
 
+        /// <summary>
+        /// Gets the
+        /// <see cref="AnnotationDefaultAppearance"/>
+        /// 's representation as
+        /// <see cref="iText.Kernel.Pdf.PdfString"/>.
+        /// </summary>
+        /// <returns>
+        /// the
+        /// <see cref="iText.Kernel.Pdf.PdfString"/>
+        /// representation of this
+        /// <see cref="AnnotationDefaultAppearance"/>
+        /// </returns>
         public virtual PdfString ToPdfString() {
             return new PdfString(MessageFormatUtil.Format("{0} {1} Tf {2}", rawFontName, fontSize, colorOperand));
         }

port-hash

@@ -1 +1 @@
-6b4a548067d754ff7b82375a1cc12495a83db152
+685ed690cca02736d8eba8043fc6b5ff487475a2