svn commit: r1860388 - /pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/PDSignature.java

[ti...@apache.org]

Author: tilman
Date: Thu May 30 08:30:26 2019
New Revision: 1860388

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

Modified:
    pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/PDSignature.java

Modified: pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/PDSignature.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/PDSignature.java?rev=1860388&r1=1860387&r2=1860388&view=diff
==============================================================================
--- pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/PDSignature.java (original)
+++ pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/PDSignature.java Thu May 30 08:30:26 2019
@@ -383,9 +383,13 @@ public class PDSignature implements COSO
   }
   
   /**
-   * Will return the signed content of the document.
-   * 
-   * @param pdfFile The signed pdf file as InputStream
+   * Return the signed content of the document. This is not a PDF file, nor is it the PDF file
+   * before signing, it is the byte sequence made of the input minus the area where the signature
+   * bytes will be. See "The ByteRange and signature value" in the document
+   * <a href="https://www.adobe.com/devnet-docs/acrobatetk/tools/DigSig/Acrobat_DigitalSignatures_in_PDF.pdf#page=5">Digital
+   * Signatures in a PDF</a>.
+   *
+   * @param pdfFile The signed pdf file as InputStream. It will be closed in this method.
    * @return a byte array containing only the signed part of the content
    * @throws IOException if the pdfFile can't be read
    */