svn commit: r1624828 - /pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocument.java

[le...@apache.org]

Author: lehmi
Date: Sun Sep 14 10:20:22 2014
New Revision: 1624828

URL: http://svn.apache.org/r1624828
Log:
PDFBOX-2301: updated documentation

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=1624828&r1=1624827&r2=1624828&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 Sun Sep 14 10:20:22 2014
@@ -480,7 +480,7 @@ public class PDDocument implements Close
     }
 
     /**
-     * This will add a signaturefield to the document.
+     * This will add a signature field to the document.
      * 
      * @param sigFields are the PDSignatureFields that should be added to the document
      * @param signatureInterface is a interface which provides signing capabilities
@@ -1048,6 +1048,7 @@ public class PDDocument implements Close
      * Parses PDF with non sequential parser.
      * 
      * @param file file to be loaded
+     * @param useScratchFiles enables the usage of a scratch file if set to true
      * 
      * @return loaded document
      * 
@@ -1078,6 +1079,7 @@ public class PDDocument implements Close
      * 
      * @param file file to be loaded
      * @param password password to be used for decryption
+     * @param useScratchFiles enables the usage of a scratch file if set to true
      * 
      * @return loaded document
      * 
@@ -1108,6 +1110,7 @@ public class PDDocument implements Close
      * Parses PDF with non sequential parser.
      * 
      * @param input stream that contains the document.
+     * @param useScratchFiles enables the usage of a scratch file if set to true
      * 
      * @return loaded document
      * 
@@ -1139,6 +1142,7 @@ public class PDDocument implements Close
      * 
      * @param input stream that contains the document.
      * @param password password to be used for decryption
+     * @param useScratchFiles enables the usage of a scratch file if set to true
      * 
      * @return loaded document
      * 
@@ -1324,6 +1328,8 @@ public class PDDocument implements Close
      * @see org.apache.pdfbox.pdmodel.encryption.PublicKeyProtectionPolicy
      * 
      * @param policy The protection policy.
+     * 
+     * @throws IOException if there isn't any suitable security handler.
      */
     public void protect(ProtectionPolicy policy) throws IOException
     {