Cover several layout properties with documentation

DEVSIX-6639

Autoported commit.
Original commit hash: [fd79d9fa9]

Author: AnhelinaM

itext/itext.layout/itext/layout/properties/BackgroundImage.cs

@@ -44,6 +44,7 @@ source product.
 using iText.Kernel.Pdf.Xobject;
 
 namespace iText.Layout.Properties {
+    /// <summary>Class to hold background-image property.</summary>
     public class BackgroundImage {
         private static readonly BlendMode DEFAULT_BLEND_MODE = BlendMode.NORMAL;
 
@@ -80,10 +81,28 @@ public BackgroundImage(iText.Layout.Properties.BackgroundImage backgroundImage)
                 (), backgroundImage.GetBackgroundOrigin()) {
         }
 
+        /// <summary>
+        /// Gets initial image if it is instanceof
+        /// <see cref="iText.Kernel.Pdf.Xobject.PdfImageXObject"/>
+        /// , otherwise returns null.
+        /// </summary>
+        /// <returns>
+        /// 
+        /// <see cref="iText.Kernel.Pdf.Xobject.PdfImageXObject"/>
+        /// </returns>
         public virtual PdfImageXObject GetImage() {
             return image is PdfImageXObject ? (PdfImageXObject)image : null;
         }
 
+        /// <summary>
+        /// Gets initial image if it is instanceof
+        /// <see cref="iText.Kernel.Pdf.Xobject.PdfFormXObject"/>
+        /// , otherwise returns null.
+        /// </summary>
+        /// <returns>
+        /// 
+        /// <see cref="iText.Kernel.Pdf.Xobject.PdfFormXObject"/>
+        /// </returns>
         public virtual PdfFormXObject GetForm() {
             return image is PdfFormXObject ? (PdfFormXObject)image : null;
         }
@@ -157,10 +176,21 @@ public virtual BackgroundPosition GetBackgroundPosition() {
             return position;
         }
 
+        /// <summary>Gets linearGradientBuilder.</summary>
+        /// <returns>
+        /// 
+        /// <see cref="iText.Kernel.Colors.Gradients.AbstractLinearGradientBuilder"/>
+        /// </returns>
         public virtual AbstractLinearGradientBuilder GetLinearGradientBuilder() {
             return this.linearGradientBuilder;
         }
 
+        /// <summary>Returns is background specified.</summary>
+        /// <returns>
+        /// 
+        /// <see langword="true"/>
+        /// if background is specified, otherwise false
+        /// </returns>
         public virtual bool IsBackgroundSpecified() {
             return image is PdfFormXObject || image is PdfImageXObject || linearGradientBuilder != null;
         }
@@ -246,6 +276,11 @@ public class Builder {
 
             private BackgroundBox origin = BackgroundBox.PADDING_BOX;
 
+            /// <summary>
+            /// Creates a new
+            /// <see cref="Builder"/>
+            /// instance.
+            /// </summary>
             public Builder() {
             }
 

itext/itext.layout/itext/layout/properties/BackgroundPosition.cs

@@ -257,12 +257,14 @@ private static float CalculateValue(UnitValue value, float fullValue) {
             return value.IsPercentValue() ? (value.GetValue() / 100 * fullValue) : value.GetValue();
         }
 
+        /// <summary>A specialized enum containing positions in x-dimension (horizontal positions).</summary>
         public enum PositionX {
             LEFT,
             RIGHT,
             CENTER
         }
 
+        /// <summary>A specialized enum containing positions in y-dimension (vertical positions).</summary>
         public enum PositionY {
             TOP,
             BOTTOM,

itext/itext.layout/itext/layout/properties/BackgroundSize.cs

@@ -45,6 +45,17 @@ public class BackgroundSize {
         /// <summary>Image hsd a maximum size but not larger than the area.</summary>
         private bool contain;
 
+        /// <summary>
+        /// Creates a new
+        /// <see cref="BackgroundSize"/>
+        /// instance.
+        /// </summary>
+        /// <remarks>
+        /// Creates a new
+        /// <see cref="BackgroundSize"/>
+        /// instance.
+        /// The "cover" and "contain" properties are not set.
+        /// </remarks>
         public BackgroundSize() {
             cover = false;
             contain = false;

itext/itext.layout/itext/layout/properties/ListSymbolPosition.cs

@@ -41,6 +41,7 @@ source product.
 address: [email protected]
 */
 namespace iText.Layout.Properties {
+    /// <summary>A specialized enum containing position properties for list symbols.</summary>
     public enum ListSymbolPosition {
         DEFAULT,
         INSIDE,

itext/itext.layout/itext/layout/properties/OverflowWrapPropertyValue.cs

@@ -21,6 +21,19 @@ You should have received a copy of the GNU Affero General Public License
 along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 namespace iText.Layout.Properties {
+    /// <summary>The possible values for the overflow wrap property.</summary>
+    /// <remarks>
+    /// The possible values for the overflow wrap property.
+    /// <para />
+    /// <see cref="ANYWHERE"/>
+    /// and
+    /// <see cref="BREAK_WORD"/>
+    /// mean that long words will break if they overflow the container.
+    /// <para />
+    /// <see cref="NORMAL"/>
+    /// means that long words will not break,
+    /// even if they overflow the container.
+    /// </remarks>
     public enum OverflowWrapPropertyValue {
         ANYWHERE,
         BREAK_WORD,

itext/itext.layout/itext/layout/properties/TransparentColor.cs

@@ -45,33 +45,80 @@ source product.
 using iText.Kernel.Pdf.Extgstate;
 
 namespace iText.Layout.Properties {
+    /// <summary>Represents a color with the specified opacity.</summary>
     public class TransparentColor {
         private Color color;
 
         private float opacity;
 
+        /// <summary>
+        /// Creates a new
+        /// <see cref="TransparentColor"/>
+        /// instance of certain fully opaque color.
+        /// </summary>
+        /// <param name="color">
+        /// the
+        /// <see cref="iText.Kernel.Colors.Color"/>
+        /// of the created
+        /// <see cref="TransparentColor"/>
+        /// object
+        /// </param>
         public TransparentColor(Color color) {
             this.color = color;
             this.opacity = 1f;
         }
 
+        /// <summary>
+        /// Creates a new
+        /// <see cref="TransparentColor"/>.
+        /// </summary>
+        /// <param name="color">
+        /// the
+        /// <see cref="iText.Kernel.Colors.Color"/>
+        /// of the created
+        /// <see cref="TransparentColor"/>
+        /// object
+        /// </param>
+        /// <param name="opacity">
+        /// a float defining the opacity of the color; a float between 0 and 1,
+        /// where 1 stands for fully opaque color and 0 - for fully transparent
+        /// </param>
         public TransparentColor(Color color, float opacity) {
             this.color = color;
             this.opacity = opacity;
         }
 
+        /// <summary>Gets the color.</summary>
+        /// <returns>
+        /// a
+        /// <see cref="iText.Kernel.Colors.Color"/>
+        /// </returns>
         public virtual Color GetColor() {
             return color;
         }
 
+        /// <summary>Gets the opacity of color.</summary>
+        /// <returns>a float between 0 and 1, where 1 stands for fully opaque color and 0 - for fully transparent</returns>
         public virtual float GetOpacity() {
             return opacity;
         }
 
+        /// <summary>Sets the opacity value for <b>non-stroking</b> operations in the transparent imaging model.</summary>
+        /// <param name="canvas">
+        /// the
+        /// <see cref="iText.Kernel.Pdf.Canvas.PdfCanvas"/>
+        /// to be written to
+        /// </param>
         public virtual void ApplyFillTransparency(PdfCanvas canvas) {
             ApplyTransparency(canvas, false);
         }
 
+        /// <summary>Sets the opacity value for <b>stroking</b> operations in the transparent imaging model.</summary>
+        /// <param name="canvas">
+        /// the
+        /// <see cref="iText.Kernel.Pdf.Canvas.PdfCanvas"/>
+        /// to be written to
+        /// </param>
         public virtual void ApplyStrokeTransparency(PdfCanvas canvas) {
             ApplyTransparency(canvas, true);
         }

port-hash

@@ -1 +1 @@
-30c6c9e883a50dae6adb0bfe884414f0d682cc31
+fd79d9fa94c2f6564df5670f97cdee1b13002413