PDFBOX-5853: improve javadoc

git-svn-id: https://svn.apache.org/repos/asf/pdfbox/trunk@1919568 13f79535-47bb-0310-9956-ffa450edef68
apache · Jul 28, 2024 · d5763f9 · d5763f9
1 parent b03d12d
commit d5763f9
Showing 1 changed file with 9 additions and 3 deletions.
diff --git a/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocument.java b/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocument.java
@@ -1362,7 +1362,10 @@ public void setAllSecurityToBeRemoved(boolean removeAllSecurity)
     }
 
     /**
-     * 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
      */
@@ -1372,8 +1375,11 @@ public Long getDocumentId()
     }
 
     /**
-     * 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)