Author: tilman
Date: Tue Feb 6 19:53:11 2018
New Revision: 1823382
URL: http://svn.apache.org/viewvc?rev=1823382&view=rev
Log:
PDFBOX-4071: improve javadoc
Modified:
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocumentCatalog.java
Modified:
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocumentCatalog.java
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocumentCatalog.java?rev=1823382&r1=1823381&r2=1823382&view=diff
==============================================================================
---
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocumentCatalog.java
(original)
+++
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocumentCatalog.java
Tue Feb 6 19:53:11 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.
