Author: tilman
Date: Fri Apr 5 18:18:35 2019
New Revision: 1857024
URL: http://svn.apache.org/viewvc?rev=1857024&view=rev
Log:
PDFBOX-45: improve javadoc
Modified:
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdfwriter/COSWriter.java
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocument.java
Modified:
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdfwriter/COSWriter.java
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdfwriter/COSWriter.java?rev=1857024&r1=1857023&r2=1857024&view=diff
==============================================================================
---
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdfwriter/COSWriter.java
(original)
+++
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdfwriter/COSWriter.java
Fri Apr 5 18:18:35 2019
@@ -228,7 +228,9 @@ public class COSWriter implements ICOSVi
}
/**
- * COSWriter constructor for incremental updates.
+ * COSWriter constructor for incremental updates. 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.
*
* @param outputStream output stream where the new PDF data will be
written. It will be closed
* when this object is closed.
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=1857024&r1=1857023&r2=1857024&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
Fri Apr 5 18:18:35 2019
@@ -1252,7 +1252,9 @@ public class PDDocument implements Close
/**
* Save the PDF as an incremental update. This is only possible if the PDF
was loaded from a
- * file or a stream, not if the document was created in PDFBox itself.
+ * 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.
*
* @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
