Document that the range of pages for copying in PdfDocument methods is inclusive

Autoported commit.
Original commit hash: [ba3c8ebcb]

Author: yulian-gaponenko

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

@@ -951,12 +951,17 @@ public virtual IList<PdfPage> CopyPagesTo(int pageFrom, int pageTo, iText.Kernel
         /// <summary>
         /// Copies a range of pages from current document to
         /// <paramref name="toDocument"/>
-        /// .
+        /// . This range is inclusive, both
+        /// <c>page</c>
+        /// and
+        /// <paramref name="pageTo"/>
+        /// are included in list of copied pages.
         /// Use this method if you want to copy pages across tagged documents.
         /// This will keep resultant PDF structure consistent.
         /// </summary>
         /// <param name="pageFrom">1-based start of the range of pages to be copied.</param>
-        /// <param name="pageTo">1-based end of the range of pages to be copied.</param>
+        /// <param name="pageTo">1-based end (inclusive) of the range of pages to be copied. This page is included in list of copied pages.
+        ///     </param>
         /// <param name="toDocument">a document to copy pages to.</param>
         /// <param name="insertBeforePage">a position where to insert copied pages.</param>
         /// <param name="copier">
@@ -978,12 +983,18 @@ public virtual IList<PdfPage> CopyPagesTo(int pageFrom, int pageTo, iText.Kernel
         /// <summary>
         /// Copies a range of pages from current document to
         /// <paramref name="toDocument"/>
-        /// appending copied pages to the end.
+        /// appending copied pages to the end. This range
+        /// is inclusive, both
+        /// <c>page</c>
+        /// and
+        /// <paramref name="pageTo"/>
+        /// are included in list of copied pages.
         /// Use this method if you want to copy pages across tagged documents.
         /// This will keep resultant PDF structure consistent.
         /// </summary>
         /// <param name="pageFrom">1-based start of the range of pages to be copied.</param>
-        /// <param name="pageTo">1-based end of the range of pages to be copied.</param>
+        /// <param name="pageTo">1-based end (inclusive) of the range of pages to be copied. This page is included in list of copied pages.
+        ///     </param>
         /// <param name="toDocument">a document to copy pages to.</param>
         /// <returns>list of new copied pages</returns>
         public virtual IList<PdfPage> CopyPagesTo(int pageFrom, int pageTo, iText.Kernel.Pdf.PdfDocument toDocument
@@ -994,12 +1005,18 @@ public virtual IList<PdfPage> CopyPagesTo(int pageFrom, int pageTo, iText.Kernel
         /// <summary>
         /// Copies a range of pages from current document to
         /// <paramref name="toDocument"/>
-        /// appending copied pages to the end.
+        /// appending copied pages to the end. This range
+        /// is inclusive, both
+        /// <c>page</c>
+        /// and
+        /// <paramref name="pageTo"/>
+        /// are included in list of copied pages.
         /// Use this method if you want to copy pages across tagged documents.
         /// This will keep resultant PDF structure consistent.
         /// </summary>
         /// <param name="pageFrom">1-based start of the range of pages to be copied.</param>
-        /// <param name="pageTo">1-based end of the range of pages to be copied.</param>
+        /// <param name="pageTo">1-based end (inclusive) of the range of pages to be copied. This page is included in list of copied pages.
+        ///     </param>
         /// <param name="toDocument">a document to copy pages to.</param>
         /// <param name="copier">
         /// a copier which bears a special copy logic. May be null.
@@ -1020,7 +1037,7 @@ public virtual IList<PdfPage> CopyPagesTo(int pageFrom, int pageTo, iText.Kernel
         /// Use this method if you want to copy pages across tagged documents.
         /// This will keep resultant PDF structure consistent.
         /// </summary>
-        /// <param name="pagesToCopy">list of pages to be copied. TreeSet for the order of the pages to be natural.</param>
+        /// <param name="pagesToCopy">list of pages to be copied.</param>
         /// <param name="toDocument">a document to copy pages to.</param>
         /// <param name="insertBeforePage">a position where to insert copied pages.</param>
         /// <returns>list of new copied pages</returns>
@@ -1036,7 +1053,7 @@ public virtual IList<PdfPage> CopyPagesTo(IList<int> pagesToCopy, iText.Kernel.P
         /// Use this method if you want to copy pages across tagged documents.
         /// This will keep resultant PDF structure consistent.
         /// </summary>
-        /// <param name="pagesToCopy">list of pages to be copied. TreeSet for the order of the pages to be natural.</param>
+        /// <param name="pagesToCopy">list of pages to be copied.</param>
         /// <param name="toDocument">a document to copy pages to.</param>
         /// <param name="insertBeforePage">a position where to insert copied pages.</param>
         /// <param name="copier">
@@ -1126,7 +1143,7 @@ public virtual IList<PdfPage> CopyPagesTo(IList<int> pagesToCopy, iText.Kernel.P
         /// Use this method if you want to copy pages across tagged documents.
         /// This will keep resultant PDF structure consistent.
         /// </summary>
-        /// <param name="pagesToCopy">list of pages to be copied. TreeSet for the order of the pages to be natural.</param>
+        /// <param name="pagesToCopy">list of pages to be copied.</param>
         /// <param name="toDocument">a document to copy pages to.</param>
         /// <returns>list of copied pages</returns>
         public virtual IList<PdfPage> CopyPagesTo(IList<int> pagesToCopy, iText.Kernel.Pdf.PdfDocument toDocument) {
@@ -1140,7 +1157,7 @@ public virtual IList<PdfPage> CopyPagesTo(IList<int> pagesToCopy, iText.Kernel.P
         /// Use this method if you want to copy pages across tagged documents.
         /// This will keep resultant PDF structure consistent.
         /// </summary>
-        /// <param name="pagesToCopy">list of pages to be copied. TreeSet for the order of the pages to be natural.</param>
+        /// <param name="pagesToCopy">list of pages to be copied.</param>
         /// <param name="toDocument">a document to copy pages to.</param>
         /// <param name="copier">
         /// a copier which bears a special copy logic. May be null.

itext/itext.kernel/itext/kernel/utils/PdfMerger.cs

@@ -117,7 +117,7 @@ public virtual iText.Kernel.Utils.PdfMerger SetCloseSourceDocuments(bool closeSo
         /// </remarks>
         /// <param name="from">- document, from which pages will be copied.</param>
         /// <param name="fromPage">- start page in the range of pages to be copied.</param>
-        /// <param name="toPage">- end page in the range to be copied.</param>
+        /// <param name="toPage">- end (inclusive) page in the range to be copied</param>
         /// <returns>
         /// this
         /// <c>PdfMerger</c>

port-hash

@@ -1 +1 @@
-ffcefc4e29a27d1159a48db20c6145b467445df2
+ba3c8ebcb58056b8458840ab1190aa9e03f9deb8