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 2024/07/28 18:12:06 UTC

svn commit: r1919567 - /pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocument.java

Author: tilman
Date: Sun Jul 28 18:12:06 2024
New Revision: 1919567

URL: http://svn.apache.org/viewvc?rev=1919567&view=rev
Log:
PDFBOX-5853: 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=1919567&r1=1919566&r2=1919567&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 Sun Jul 28 18:12:06 2024
@@ -1719,7 +1719,10 @@ public class PDDocument implements Close
     }
 
     /**
-     * Provides the document ID.
+     * Provides the document ID. This is not the trailer document ID but the time used to create it.
+     * Use {@link COSDocument#getDocumentID()} for the trailer document ID. Read
+     * <a href="https://issues.apache.org/jira/browse/PDFBOX-1613">PDFBOX-1613</a> for more details
+     * about the purpose.
      *
      * @return the document ID
      */
@@ -1729,8 +1732,11 @@ public class PDDocument implements Close
     }
 
     /**
-     * Sets the document ID to the given value.
-     * 
+     * Sets the document ID to the given value. This is not the trailer document ID but the time
+     * used to create it. Use {@link COSDocument#getDocumentID()} for the trailer document ID. Read
+     * <a href="https://issues.apache.org/jira/browse/PDFBOX-1613">PDFBOX-1613</a> for more details
+     * about the purpose.
+     *
      * @param docId the new document ID
      */
     public void setDocumentId(Long docId)