Cover pattern and shading related constants with javadocs

DEVSIX-5011

Autoported commit.
Original commit hash: [0cbf75948]

Author: ars18wrw

itext/itext.kernel/itext/kernel/pdf/canvas/PdfCanvasConstants.cs

@@ -178,13 +178,16 @@ private LineJoinStyle() {
             public const int BEVEL = 2;
         }
 
+        /// <summary>Rule for determining which points lie inside a path.</summary>
         public class FillingRule {
             private FillingRule() {
             }
 
             // This private constructor will prevent the instantiation of this class
+            /// <summary>The nonzero winding number rule.</summary>
             public const int NONZERO_WINDING = 1;
 
+            /// <summary>The even-odd winding number rule.</summary>
             public const int EVEN_ODD = 2;
         }
     }

itext/itext.kernel/itext/kernel/pdf/colorspace/PdfPattern.cs

@@ -57,6 +57,16 @@ namespace iText.Kernel.Pdf.Colorspace {
     /// For mor information see paragraph 8.7 in ISO-32000-1.
     /// </remarks>
     public abstract class PdfPattern : PdfObjectWrapper<PdfDictionary> {
+        /// <summary>
+        /// Wraps the passed
+        /// <see cref="iText.Kernel.Pdf.PdfDictionary"/>
+        /// </summary>
+        /// <param name="pdfObject">
+        /// the
+        /// <see cref="iText.Kernel.Pdf.PdfDictionary"/>
+        /// that represent Pattern
+        /// </param>
+        /// <returns>new wrapper instance.</returns>
         protected internal PdfPattern(PdfDictionary pdfObject)
             : base(pdfObject) {
         }
@@ -206,34 +216,82 @@ public Tiling(PdfStream pdfObject)
                 : base(pdfObject) {
             }
 
+            /// <summary>Creates a new Tiling Pattern instance.</summary>
+            /// <remarks>
+            /// Creates a new Tiling Pattern instance.
+            /// By default the pattern will be colored.
+            /// </remarks>
+            /// <param name="width">the width of the pattern cell's bounding box</param>
+            /// <param name="height">the height of the pattern cell's bounding box</param>
             public Tiling(float width, float height)
                 : this(width, height, true) {
             }
 
+            /// <summary>Creates a new Tiling Pattern instance.</summary>
+            /// <param name="width">the width of the pattern cell's bounding box</param>
+            /// <param name="height">the height of the pattern cell's bounding box</param>
+            /// <param name="colored">defines whether the Tiling Pattern will be colored or not</param>
             public Tiling(float width, float height, bool colored)
                 : this(new Rectangle(width, height), colored) {
             }
 
+            /// <summary>Creates a new Tiling instance.</summary>
+            /// <remarks>
+            /// Creates a new Tiling instance.
+            /// By default the pattern will be colored.
+            /// </remarks>
+            /// <param name="bbox">the pattern cell's bounding box</param>
             public Tiling(Rectangle bbox)
                 : this(bbox, true) {
             }
 
+            /// <summary>Creates a new Tiling instance.</summary>
+            /// <param name="bbox">the pattern cell's bounding box</param>
+            /// <param name="colored">defines whether the Tiling Pattern will be colored or not</param>
             public Tiling(Rectangle bbox, bool colored)
                 : this(bbox, bbox.GetWidth(), bbox.GetHeight(), colored) {
             }
 
+            /// <summary>Creates a new Tiling Pattern instance.</summary>
+            /// <remarks>
+            /// Creates a new Tiling Pattern instance.
+            /// By default the pattern will be colored.
+            /// </remarks>
+            /// <param name="width">the width of the pattern cell's bounding box</param>
+            /// <param name="height">the height of the pattern cell's bounding box</param>
+            /// <param name="xStep">the desired horizontal space between pattern cells</param>
+            /// <param name="yStep">the desired vertical space between pattern cells</param>
             public Tiling(float width, float height, float xStep, float yStep)
                 : this(width, height, xStep, yStep, true) {
             }
 
+            /// <summary>Creates a new Tiling Pattern instance.</summary>
+            /// <param name="width">the width of the pattern cell's bounding box</param>
+            /// <param name="height">the height of the pattern cell's bounding box</param>
+            /// <param name="xStep">the desired horizontal space between pattern cells</param>
+            /// <param name="yStep">the desired vertical space between pattern cells</param>
+            /// <param name="colored">defines whether the Tiling Pattern will be colored or not</param>
             public Tiling(float width, float height, float xStep, float yStep, bool colored)
                 : this(new Rectangle(width, height), xStep, yStep, colored) {
             }
 
+            /// <summary>Creates a new Tiling instance.</summary>
+            /// <remarks>
+            /// Creates a new Tiling instance.
+            /// By default the pattern will be colored.
+            /// </remarks>
+            /// <param name="bbox">the pattern cell's bounding box</param>
+            /// <param name="xStep">the desired horizontal space between pattern cells</param>
+            /// <param name="yStep">the desired vertical space between pattern cells</param>
             public Tiling(Rectangle bbox, float xStep, float yStep)
                 : this(bbox, xStep, yStep, true) {
             }
 
+            /// <summary>Creates a new Tiling instance.</summary>
+            /// <param name="bbox">the pattern cell's bounding box</param>
+            /// <param name="xStep">the desired horizontal space between pattern cells</param>
+            /// <param name="yStep">the desired vertical space between pattern cells</param>
+            /// <param name="colored">defines whether the Tiling Pattern will be colored or not</param>
             public Tiling(Rectangle bbox, float xStep, float yStep, bool colored)
                 : base(new PdfStream()) {
                 GetPdfObject().Put(PdfName.Type, PdfName.Pattern);
@@ -318,24 +376,32 @@ public virtual void SetBBox(Rectangle bbox) {
                 SetModified();
             }
 
+            /// <summary>Gets the desired horizontal space between pattern cells</summary>
+            /// <returns>the desired horizontal space between pattern cells</returns>
             public virtual float GetXStep() {
                 return GetPdfObject().GetAsNumber(PdfName.XStep).FloatValue();
             }
 
+            /// <summary>Sets the desired horizontal space between pattern cells</summary>
             public virtual void SetXStep(float xStep) {
                 GetPdfObject().Put(PdfName.XStep, new PdfNumber(xStep));
                 SetModified();
             }
 
+            /// <summary>Gets the desired vertical space between pattern cells</summary>
+            /// <returns>the desired vertical space between pattern cells</returns>
             public virtual float GetYStep() {
                 return GetPdfObject().GetAsNumber(PdfName.YStep).FloatValue();
             }
 
+            /// <summary>Sets the desired vertical space between pattern cells</summary>
             public virtual void SetYStep(float yStep) {
                 GetPdfObject().Put(PdfName.YStep, new PdfNumber(yStep));
                 SetModified();
             }
 
+            /// <summary>Gets the Tiling Pattern's resources</summary>
+            /// <returns>the Tiling Pattern's resources</returns>
             public virtual PdfResources GetResources() {
                 if (this.resources == null) {
                     PdfDictionary resourcesDict = GetPdfObject().GetAsDictionary(PdfName.Resources);
@@ -355,27 +421,84 @@ public override void Flush() {
             }
         }
 
+        /// <summary>
+        /// Shading pattern provides a smooth transition between colors across an area to be painted,
+        /// independent of the resolution of any particular output device and without specifying
+        /// the number of steps in the color transition.
+        /// </summary>
+        /// <remarks>
+        /// Shading pattern provides a smooth transition between colors across an area to be painted,
+        /// independent of the resolution of any particular output device and without specifying
+        /// the number of steps in the color transition. Patterns of this type are described
+        /// by pattern dictionaries with a pattern type of 2.
+        /// </remarks>
         public class Shading : PdfPattern {
+            /// <summary>
+            /// Creates new instance from the
+            /// <see cref="iText.Kernel.Pdf.PdfStream"/>
+            /// object.
+            /// </summary>
+            /// <remarks>
+            /// Creates new instance from the
+            /// <see cref="iText.Kernel.Pdf.PdfStream"/>
+            /// object.
+            /// This stream should have PatternType equals to 2.
+            /// </remarks>
+            /// <param name="pdfObject">
+            /// the
+            /// <see cref="iText.Kernel.Pdf.PdfStream"/>
+            /// that represents Shading Pattern.
+            /// </param>
             public Shading(PdfDictionary pdfObject)
                 : base(pdfObject) {
             }
 
+            /// <summary>Creates a new instance of Shading Pattern.</summary>
+            /// <param name="shading">
+            /// the
+            /// <see cref="PdfShading"/>
+            /// that specifies the details of a particular
+            /// gradient fill
+            /// </param>
             public Shading(PdfShading shading)
                 : base(new PdfDictionary()) {
                 GetPdfObject().Put(PdfName.Type, PdfName.Pattern);
                 GetPdfObject().Put(PdfName.PatternType, new PdfNumber(2));
                 GetPdfObject().Put(PdfName.Shading, shading.GetPdfObject());
             }
 
+            /// <summary>
+            /// Gets the dictionary of the pattern's
+            /// <see cref="PdfShading"/>
+            /// </summary>
+            /// <returns>
+            /// the dictionary of the pattern's
+            /// <see cref="PdfShading"/>
+            /// </returns>
             public virtual PdfDictionary GetShading() {
                 return (PdfDictionary)GetPdfObject().Get(PdfName.Shading);
             }
 
+            /// <summary>
+            /// Sets the
+            /// <see cref="PdfShading"/>
+            /// that specifies the details of a particular gradient fill
+            /// </summary>
+            /// <param name="shading">
+            /// the
+            /// <see cref="PdfShading"/>
+            /// that specifies the details of a particular gradient fill
+            /// </param>
             public virtual void SetShading(PdfShading shading) {
                 GetPdfObject().Put(PdfName.Shading, shading.GetPdfObject());
                 SetModified();
             }
 
+            /// <summary>Sets the dictionary which specifies the details of a particular gradient fill</summary>
+            /// <param name="shading">
+            /// the dictionary of the pattern's
+            /// <see cref="PdfShading"/>
+            /// </param>
             public virtual void SetShading(PdfDictionary shading) {
                 GetPdfObject().Put(PdfName.Shading, shading);
                 SetModified();