You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pdfbox.apache.org by ms...@apache.org on 2020/11/07 13:48:41 UTC

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

Author: msahyoun
Date: Sat Nov  7 13:48:41 2020
New Revision: 1883176

URL: http://svn.apache.org/viewvc?rev=1883176&view=rev
Log:
PDFBOX-4985: adjust Javadoc to match new acroFormFixup parameter

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=1883176&r1=1883175&r2=1883176&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 Sat Nov  7 13:48:41 2020
@@ -116,14 +116,13 @@ public class PDDocumentCatalog implement
     /**
      * Get the documents AcroForm. This will return null if no AcroForm is part of the document.
      *
-     * Depent on setting <code>applyFixes</code> some fixing/changes will be done to the AcroForm
-     * as documented in {@link org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm#PDAcroForm(PDDocument, COSDictionary, boolean)}.
-     * If you need to ensure that there are no fixes applied call <code>applyFixes</code> with <code>false</code>.
+     * Dependent on setting <code>documentFixup</code> some fixing/changes will be done to the AcroForm.
+     * If you need to ensure that there are no fixes applied call <code>documentFixup</code> with <code>null</code>.
      * 
-     * Using <code>getAcroForm(true)</code> might change the original content and subsequent calls with
-     * <code>getAcroForm(false)</code> will return the changed content.
+     * Using <code>getAcroForm(PDDocumentFixup documentFixup)</code> might change the original content and
+     * subsequent calls with <code>getAcroForm(null)</code> will return the changed content.
      * 
-     * @param applyFixes applies fixes
+     * @param acroFormFixup the fix up action or null
      * @return The document's AcroForm.
      */
     public PDAcroForm getAcroForm(PDDocumentFixup acroFormFixup)