From d5763f9c21095610eff8d92fd08666386fe03249 Mon Sep 17 00:00:00 2001 From: Tilman Hausherr Date: Sun, 28 Jul 2024 18:12:10 +0000 Subject: [PATCH] PDFBOX-5853: improve javadoc git-svn-id: https://svn.apache.org/repos/asf/pdfbox/trunk@1919568 13f79535-47bb-0310-9956-ffa450edef68 --- .../java/org/apache/pdfbox/pdmodel/PDDocument.java | 12 +++++++++--- 1 file changed, 9 insertions(+), 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 index f78c5b3cb52..f81ab61a56c 100644 --- 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 + * PDFBOX-1613 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 + * PDFBOX-1613 for more details + * about the purpose. + * * @param docId the new document ID */ public void setDocumentId(Long docId)