Update Javadocs of PdfCanvas#addXobject(PdfXObject, Rectangle) to mention scaling behavior. DEVSIX-2541

Autoported commit.
Original commit hash: [85bf9e40a]

Author: michaeldemey

itext/itext.kernel/itext/kernel/pdf/canvas/PdfCanvas.cs

@@ -1813,9 +1813,20 @@ public virtual iText.Kernel.Pdf.Canvas.PdfCanvas AddXObject(PdfXObject xObject,
         /// Adds
         /// <c>PdfXObject</c>
         /// to specified rectangle on canvas.
+        /// Do note that using this method of adding an XObject <b>will scale</b> the XObject using the width and the height
+        /// of the provided Rectangle. If you don't wish to scale the XObject, use
+        /// <see cref="AddXObject(iText.Kernel.Pdf.Xobject.PdfXObject, float, float)"/>
+        /// ,
+        /// <see cref="AddXObject(iText.Kernel.Pdf.Xobject.PdfXObject, float, float, float)"/>
+        /// ,
+        /// <see cref="AddXObject(iText.Kernel.Pdf.Xobject.PdfXObject, float, float, float, bool)"/>
+        /// ,
+        /// or
+        /// <see cref="AddXObject(iText.Kernel.Pdf.Xobject.PdfXObject, float, float, float, float, float, float)"/>
+        /// .
         /// </summary>
-        /// <param name="xObject"/>
-        /// <param name="rect"/>
+        /// <param name="xObject">the XObject to add</param>
+        /// <param name="rect">rectangle containing x and y coordinates and scaling information</param>
         /// <returns>current canvas.</returns>
         public virtual iText.Kernel.Pdf.Canvas.PdfCanvas AddXObject(PdfXObject xObject, iText.Kernel.Geom.Rectangle
              rect) {
@@ -2123,10 +2134,10 @@ private iText.Kernel.Pdf.Canvas.PdfCanvas AddForm(PdfFormXObject form, float x,
         /// <summary>
         /// Adds
         /// <c>PdfFormXObject</c>
-        /// to specified rectangle on canvas.
+        /// to specified rectangle on canvas and scale it using the rectangle's width and height.
         /// </summary>
-        /// <param name="form"/>
-        /// <param name="rect"/>
+        /// <param name="form">PdfFormXObject to add</param>
+        /// <param name="rect">rectangle containing x and y coordinates and scaling information</param>
         /// <returns>current canvas.</returns>
         private iText.Kernel.Pdf.Canvas.PdfCanvas AddForm(PdfFormXObject form, iText.Kernel.Geom.Rectangle rect) {
             return AddForm(form, rect.GetWidth(), 0, 0, rect.GetHeight(), rect.GetX(), rect.GetY());
@@ -2227,10 +2238,10 @@ private iText.Kernel.Pdf.Canvas.PdfCanvas AddImage(PdfImageXObject image, float
         /// <summary>
         /// Adds
         /// <c>PdfImageXObject</c>
-        /// to specified rectangle on canvas.
+        /// to specified rectangle on canvas and scale it using the rectangle's width and height.
         /// </summary>
-        /// <param name="image"/>
-        /// <param name="rect"/>
+        /// <param name="image">PdfImageXObject to add</param>
+        /// <param name="rect">rectangle containing x and y coordinates and scaling information</param>
         /// <returns>current canvas</returns>
         private iText.Kernel.Pdf.Canvas.PdfCanvas AddImage(PdfImageXObject image, iText.Kernel.Geom.Rectangle rect
             ) {

port-hash

@@ -1 +1 @@
-fd08e4dc0d15c8afab81ce470e0b39341afda840
+85bf9e40a7470200265d0232ce8fd1ee6c945f0d