svn commit: r1823086 - in /pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox: pdfparser/ pdmodel/encryption/ pdmodel/graphics/state/ pdmodel/interactive/digitalsignature/visible/ pdmodel/interactive/form/

[ms...@apache.org]

Author: msahyoun
Date: Sun Feb  4 11:15:09 2018
New Revision: 1823086

URL: http://svn.apache.org/viewvc?rev=1823086&view=rev
Log:
PDFBOX-4071: fix javadoc warnings

Modified:
    pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdfparser/FDFParser.java
    pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/encryption/StandardProtectionPolicy.java
    pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/state/PDSoftMask.java
    pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/visible/PDFTemplateCreator.java
    pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDNonTerminalField.java

Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdfparser/FDFParser.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdfparser/FDFParser.java?rev=1823086&r1=1823085&r2=1823086&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdfparser/FDFParser.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdfparser/FDFParser.java Sun Feb  4 11:15:09 2018
@@ -78,7 +78,7 @@ public class FDFParser extends COSParser
      * Tell if the dictionary is a FDF catalog.
      *
      * @param dictionary
-     * @return
+     * @return true if the dictionary is a FDF catalog
      */
     @Override
     protected final boolean isCatalog(COSDictionary dictionary)

Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/encryption/StandardProtectionPolicy.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/encryption/StandardProtectionPolicy.java?rev=1823086&r1=1823085&r2=1823086&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/encryption/StandardProtectionPolicy.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/encryption/StandardProtectionPolicy.java Sun Feb  4 11:15:09 2018
@@ -115,7 +115,7 @@ public final class StandardProtectionPol
      * the chosen key length. The default is false. This setting is only relevant if the key length
      * is 128 bits.
      *
-     * @return
+     * @return true if AES encryption is preferred
      */
     public boolean isPreferAES()
     {

Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/state/PDSoftMask.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/state/PDSoftMask.java?rev=1823086&r1=1823085&r2=1823086&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/state/PDSoftMask.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/state/PDSoftMask.java Sun Feb  4 11:15:09 2018
@@ -173,7 +173,6 @@ public final class PDSoftMask implements
     /**
      * Returns the CTM at the time the ExtGState was activated.
      *
-     * @return
      */
     public Matrix getInitialTransformationMatrix()
     {

Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/visible/PDFTemplateCreator.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/visible/PDFTemplateCreator.java?rev=1823086&r1=1823085&r2=1823086&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/visible/PDFTemplateCreator.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/visible/PDFTemplateCreator.java Sun Feb  4 11:15:09 2018
@@ -59,7 +59,6 @@ public class PDFTemplateCreator
     /**
      * Returns the PDFTemplateStructure object.
      * 
-     * @return
      */
     public PDFTemplateStructure getPdfStructure()
     {

Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDNonTerminalField.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDNonTerminalField.java?rev=1823086&r1=1823085&r2=1823086&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDNonTerminalField.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDNonTerminalField.java Sun Feb  4 11:15:09 2018
@@ -172,7 +172,7 @@ public class PDNonTerminalField extends
     }
 
     /**
-     * {@inheritDoc}
+     * Returns the COSBase value of the "V" entry.
      *
      * <p><b>Note:</b> while non-terminal fields <b>do</b> inherit field values, this method returns
      * the local value, without inheritance.