svn commit: r1866334 - /pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocument.java

[ti...@apache.org]

Author: tilman
Date: Tue Sep  3 16:51:53 2019
New Revision: 1866334

URL: http://svn.apache.org/viewvc?rev=1866334&view=rev
Log:
PDFBOX-4641: improve javadoc

Modified:
    pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocument.java

Modified: pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocument.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocument.java?rev=1866334&r1=1866333&r2=1866334&view=diff
==============================================================================
--- pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocument.java (original)
+++ pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocument.java Tue Sep  3 16:51:53 2019
@@ -741,6 +741,10 @@ public class PDDocument implements Pagea
     /**
      * This will get the document info dictionary. If it doesn't exist, an empty document info
      * dictionary is created in the document trailer.
+     * <p>
+     * In PDF 2.0 this is deprecated except for two entries, /CreationDate and /ModDate. For any other
+     * document level metadata, a metadata stream should be used instead, see
+     * {@link PDDocumentCatalog#getMetadata()}.
      *
      * @return The documents /Info dictionary, never null.
      */
@@ -762,10 +766,14 @@ public class PDDocument implements Pagea
 
     /**
      * This will set the document information for this document.
+     * <p>
+     * In PDF 2.0 this is deprecated except for two entries, /CreationDate and /ModDate. For any other
+     * document level metadata, a metadata stream should be used instead, see
+     * {@link PDDocumentCatalog#setMetadata(org.apache.pdfbox.pdmodel.common.PDMetadata) PDDocumentCatalog#setMetadata(PDMetadata)}.
      *
      * @param info The updated document information.
      */
-    public void setDocumentInformation( PDDocumentInformation info )
+    public void setDocumentInformation(PDDocumentInformation info)
     {
         documentInformation = info;
         document.getTrailer().setItem( COSName.INFO, info.getDictionary() );