Author: tilman
Date: Thu Aug 8 13:48:54 2024
New Revision: 1919742
URL: http://svn.apache.org/viewvc?rev=1919742&view=rev
Log:
PDFBOX-5854: improve javadoc
Modified:
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSDocument.java
Modified:
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSDocument.java
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSDocument.java?rev=1919742&r1=1919741&r2=1919742&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSDocument.java
(original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSDocument.java
Thu Aug 8 13:48:54 2024
@@ -364,7 +364,10 @@ public class COSDocument extends COSBase
}
/**
- * This will set the document ID.
+ * This will set the document ID. This should be an array of two strings.
This method cannot be
+ * used to remove the document id by passing null or an empty array; it
will be recreated. Only
+ * the first existing string is used when writing, the second one is
always recreated. If you
+ * don't want this, you'll have to modify the {@link COSWriter} class,
look for {@link COSName#ID}.
*
* @param id The document id.
*/
