Add some javadocs to PdfDocument & PdfAnnotationBorder

DEVSIX-4979

Autoported commit.
Original commit hash: [09da76536]

Author: Artyom Yanchevsky

itext/itext.kernel/itext/kernel/pdf/PdfAnnotationBorder.cs

@@ -42,11 +42,59 @@ source product.
 address: [email protected]
 */
 namespace iText.Kernel.Pdf {
+    /// <summary>Specifying the characteristics of the annotation’s border.</summary>
+    /// <remarks>
+    /// Specifying the characteristics of the annotation’s border.
+    /// See ISO 32000-1 12.5.2, Table 164 - Entries common to all annotation dictionaries, Key - border.
+    /// <para />
+    /// Note (PDF 1.2): The dictionaries for some annotation types  can include the BS (border style) entry.
+    /// That entry specifies a border style dictionary that has more settings than this class.
+    /// If an annotation has BS entry, then
+    /// <see cref="PdfAnnotationBorder"/>
+    /// is ignored.
+    /// </remarks>
     public class PdfAnnotationBorder : PdfObjectWrapper<PdfArray> {
+        /// <summary>
+        /// Creates a
+        /// <see cref="PdfAnnotationBorder"/>
+        /// with three numbers defining the horizontal
+        /// corner radius, vertical corner radius, and border width, all in default user
+        /// space units.
+        /// </summary>
+        /// <remarks>
+        /// Creates a
+        /// <see cref="PdfAnnotationBorder"/>
+        /// with three numbers defining the horizontal
+        /// corner radius, vertical corner radius, and border width, all in default user
+        /// space units. If the corner radii are 0, the border has square (not rounded)
+        /// corners; if the border width is 0, no border is drawn.
+        /// </remarks>
+        /// <param name="hRadius">horizontal corner radius</param>
+        /// <param name="vRadius">vertical corner radius</param>
+        /// <param name="width">width of the border</param>
         public PdfAnnotationBorder(float hRadius, float vRadius, float width)
             : this(hRadius, vRadius, width, null) {
         }
 
+        /// <summary>
+        /// Creates a
+        /// <see cref="PdfAnnotationBorder"/>
+        /// with three numbers defining the horizontal
+        /// corner radius, vertical corner radius, and border width, all in default user
+        /// space units and a dash pattern for the border lines.
+        /// </summary>
+        /// <remarks>
+        /// Creates a
+        /// <see cref="PdfAnnotationBorder"/>
+        /// with three numbers defining the horizontal
+        /// corner radius, vertical corner radius, and border width, all in default user
+        /// space units and a dash pattern for the border lines. If the corner radii are 0,
+        /// the border has square (not rounded) corners; if the border width is 0, no border is drawn.
+        /// </remarks>
+        /// <param name="hRadius">horizontal corner radius</param>
+        /// <param name="vRadius">vertical corner radius</param>
+        /// <param name="width">width of the border</param>
+        /// <param name="dash">the dash pattern</param>
         public PdfAnnotationBorder(float hRadius, float vRadius, float width, PdfDashPattern dash)
             : base(new PdfArray(new float[] { hRadius, vRadius, width })) {
             if (dash != null) {

itext/itext.kernel/itext/kernel/pdf/PdfDocument.cs

@@ -266,10 +266,15 @@ protected internal virtual void SetXmpMetadata(byte[] xmpMetadata) {
             this.xmpMetadata = xmpMetadata;
         }
 
+        /// <summary>Sets the XMP Metadata.</summary>
+        /// <param name="xmpMeta">the xmpMetadata to set</param>
+        /// <param name="serializeOptions">serialization options</param>
         public virtual void SetXmpMetadata(XMPMeta xmpMeta, SerializeOptions serializeOptions) {
             SetXmpMetadata(XMPMetaFactory.SerializeToBuffer(xmpMeta, serializeOptions));
         }
 
+        /// <summary>Sets the XMP Metadata.</summary>
+        /// <param name="xmpMeta">the xmpMetadata to set</param>
         public virtual void SetXmpMetadata(XMPMeta xmpMeta) {
             SerializeOptions serializeOptions = new SerializeOptions();
             serializeOptions.SetPadding(2000);
@@ -1844,6 +1849,14 @@ public virtual FingerPrint GetFingerPrint() {
             return fingerPrint;
         }
 
+        /// <summary>
+        /// Find
+        /// <see cref="iText.Kernel.Font.PdfFont"/>
+        /// from loaded fonts with corresponding fontProgram and encoding or CMAP.
+        /// </summary>
+        /// <param name="fontProgram">a font name or path to a font program</param>
+        /// <param name="encoding">an encoding or CMAP</param>
+        /// <returns>the font instance, or null if font wasn't found</returns>
         public virtual PdfFont FindFont(String fontProgram, String encoding) {
             foreach (PdfFont font in documentFonts.Values) {
                 if (!font.IsFlushed() && font.IsBuiltWith(fontProgram, encoding)) {
@@ -2153,6 +2166,7 @@ protected internal virtual ICollection<PdfFont> GetDocumentFonts() {
             return documentFonts.Values;
         }
 
+        /// <summary>Flushes all newly added or loaded fonts.</summary>
         protected internal virtual void FlushFonts() {
             if (properties.appendMode) {
                 foreach (PdfFont font in GetDocumentFonts()) {
@@ -2264,6 +2278,16 @@ private void UpdateProducerInInfoDictionary() {
             info.GetPdfObject().Put(PdfName.Producer, new PdfString(producer));
         }
 
+        /// <summary>
+        /// Initializes the new instance of document's structure tree root
+        /// <see cref="iText.Kernel.Pdf.Tagging.PdfStructTreeRoot"/>.
+        /// </summary>
+        /// <remarks>
+        /// Initializes the new instance of document's structure tree root
+        /// <see cref="iText.Kernel.Pdf.Tagging.PdfStructTreeRoot"/>.
+        /// See ISO 32000-1, section 14.7.2 Structure Hierarchy.
+        /// </remarks>
+        /// <param name="str">dictionary to create structure tree root</param>
         protected internal virtual void TryInitTagStructure(PdfDictionary str) {
             try {
                 structTreeRoot = new PdfStructTreeRoot(str, this);

port-hash

@@ -1 +1 @@
-c99fd3cbd9992f3e9b5bff7676387bc6c677c64c
+09da765369970f1e8c0f8e5f79f23887eeb459b9