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 2018/02/06 19:53:06 UTC

svn commit: r1823381 - /pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocumentCatalog.java

Author: tilman
Date: Tue Feb  6 19:53:06 2018
New Revision: 1823381

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

Modified:
    pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocumentCatalog.java

Modified: pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocumentCatalog.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocumentCatalog.java?rev=1823381&r1=1823380&r2=1823381&view=diff
==============================================================================
--- pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocumentCatalog.java (original)
+++ pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocumentCatalog.java Tue Feb  6 19:53:06 2018
@@ -59,7 +59,8 @@ public class PDDocumentCatalog implement
     private PDAcroForm cachedAcroForm;
 
     /**
-     * Constructor. AcroForm.
+     * Constructor. Internal PDFBox use only! If you need to get the document catalog, call
+     * {@link PDDocument#getDocumentCatalog()}.
      *
      * @param doc The document that this catalog is part of.
      */
@@ -72,7 +73,8 @@ public class PDDocumentCatalog implement
     }
 
     /**
-     * Constructor.
+     * Constructor. Internal PDFBox use only! If you need to get the document catalog, call
+     * {@link PDDocument#getDocumentCatalog()}.
      *
      * @param doc The document that this catalog is part of.
      * @param rootDictionary The root dictionary that this object wraps.