svn commit: r1841488 - /pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocument.java

[ti...@apache.org]

Author: tilman
Date: Thu Sep 20 18:32:44 2018
New Revision: 1841488

URL: http://svn.apache.org/viewvc?rev=1841488&view=rev
Log:
PDFBOX-4319: improve javadoc

Modified:
    pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocument.java

Modified: pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocument.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocument.java?rev=1841488&r1=1841487&r2=1841488&view=diff
==============================================================================
--- pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocument.java (original)
+++ pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocument.java Thu Sep 20 18:32:44 2018
@@ -1398,9 +1398,13 @@ public class PDDocument implements Close
     }
 
     /**
-     * Returns the page at the given index.
+     * Returns the page at the given 0-based index.
+     * <p>
+     * This method is too slow to get all the pages from a large PDF document
+     * (1000 pages or more). For such documents, use the iterator of
+     * {@link PDDocument#getPages()} instead.
      *
-     * @param pageIndex the page index
+     * @param pageIndex the 0-based page index
      * @return the page at the given index.
      */
     public PDPage getPage(int pageIndex) // todo: REPLACE most calls to this method with BELOW method