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 2019/04/10 18:57:37 UTC
svn commit: r1857274 -
/pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocument.java
Author: tilman
Date: Wed Apr 10 18:57:36 2019
New Revision: 1857274
URL: http://svn.apache.org/viewvc?rev=1857274&view=rev
Log:
PDFBOX-45: improve javadoc
Modified:
pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocument.java
Modified: pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocument.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocument.java?rev=1857274&r1=1857273&r2=1857274&view=diff
==============================================================================
--- pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocument.java (original)
+++ pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocument.java Wed Apr 10 18:57:36 2019
@@ -1344,6 +1344,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