pdfbox-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From til...@apache.org
Subject svn commit: r1718432 - /pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocument.java
Date Mon, 07 Dec 2015 17:55:32 GMT
Author: tilman
Date: Mon Dec  7 17:55:31 2015
New Revision: 1718432

URL: http://svn.apache.org/viewvc?rev=1718432&view=rev
Log:
PDFBOX-2852: 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=1718432&r1=1718431&r2=1718432&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 Mon Dec  7
17:55:31 2015
@@ -185,8 +185,10 @@ public class PDDocument implements Close
     }
 
     /**
-     * This will add a signature to the document.
-     * 
+     * This will add a signature to the document. If the 0-based page number in the options
+     * parameter is smaller than 0 or larger than max, the nearest valid page number will
be used
+     * (i.e. 0 or max) and no exception will be thrown.
+     *
      * @param sigObject is the PDSignatureField model
      * @param signatureInterface is a interface which provides signing capabilities
      * @param options signature options



Mime
View raw message