You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pdfbox.apache.org by ti...@apache.org on 2018/09/20 18:32:50 UTC
svn commit: r1841489 -
/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocument.java
Author: tilman
Date: Thu Sep 20 18:32:50 2018
New Revision: 1841489
URL: http://svn.apache.org/viewvc?rev=1841489&view=rev
Log:
PDFBOX-4319: improve javadoc
Modified:
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocument.java
Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocument.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocument.java?rev=1841489&r1=1841488&r2=1841489&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocument.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocument.java Thu Sep 20 18:32:50 2018
@@ -1367,9 +1367,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