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

[ti...@apache.org]

Author: tilman
Date: Wed Apr 10 18:57:42 2019
New Revision: 1857275

URL: http://svn.apache.org/viewvc?rev=1857275&view=rev
Log:
PDFBOX-45: 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=1857275&r1=1857274&r2=1857275&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 Wed Apr 10 18:57:42 2019
@@ -1256,6 +1256,10 @@ public class PDDocument implements Close
      * file or a stream, not if the document was created in PDFBox itself. There must be a path of
      * objects that have {@link COSUpdateInfo#isNeedToBeUpdated()} set, starting from the document
      * catalog. For signatures this is taken care by PDFBox itself.
+     *<p>
+     * Other usages of this method are for experienced users only. You will usually never need it.
+     * It is useful only if you are required to keep the current revision and append the changes. A
+     * typical use case is changing a signed file without invalidating the signature.
      *
      * @param output stream to write to. It will be closed when done. It
      * <i><b>must never</b></i> point to the source file or that one will be