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 2014/10/26 12:57:00 UTC
svn commit: r1634308 - in
/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox: cos/
pdmodel/interactive/form/
Author: msahyoun
Date: Sun Oct 26 11:56:59 2014
New Revision: 1634308
URL: http://svn.apache.org/r1634308
Log:
PDFBOX-2155 fix javadoc warnings in pdfbox
Modified:
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSDocument.java
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDButton.java
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDComboBox.java
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.java
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDTextField.java
Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSDocument.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSDocument.java?rev=1634308&r1=1634307&r2=1634308&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSDocument.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSDocument.java Sun Oct 26 11:56:59 2014
@@ -76,7 +76,10 @@ public class COSDocument extends COSBase
private boolean warnMissingClose = true;
- /** signal that document is already decrypted, e.g. with {@link NonSequentialPDFParser} */
+ /**
+ * signal that document is already decrypted,
+ * e.g. with {@link org.apache.pdfbox.pdfparser.NonSequentialPDFParser}
+ */
private boolean isDecrypted = false;
private long startXref;
@@ -299,9 +302,10 @@ public class COSDocument extends COSBase
return version;
}
- /** Signals that the document is decrypted completely.
- * Needed e.g. by {@link NonSequentialPDFParser} to circumvent
- * additional decryption later on. */
+ /**
+ * Signals that the document is decrypted completely.
+ * Needed e.g. by {@link org.apache.pdfbox.pdfparser.NonSequentialPDFParser} to circumvent
+ * additional decryption later on. */
public void setDecrypted()
{
isDecrypted = true;
Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDButton.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDButton.java?rev=1634308&r1=1634307&r2=1634308&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDButton.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDButton.java Sun Oct 26 11:56:59 2014
@@ -53,7 +53,7 @@ public abstract class PDButton extends P
/**
* Constructor.
*
- * @param theAcroForm The form that this field is part of.
+ * @param acroForm The form that this field is part of.
* @param field the PDF object to represent as a field.
* @param parentNode the parent node of the node to be created
*/
Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDComboBox.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDComboBox.java?rev=1634308&r1=1634307&r2=1634308&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDComboBox.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDComboBox.java Sun Oct 26 11:56:59 2014
@@ -27,14 +27,14 @@ import org.apache.pdfbox.cos.COSName;
public final class PDComboBox extends PDChoice
{
/**
- * Ff-flag
+ * Ff-flag.
*/
private static final int FLAG_EDIT = 1 << 18;
/**
* Constructor.
*
- * @param theAcroForm The form that this field is part of.
+ * @param acroForm The form that this field is part of.
* @param field the PDF object to represent as a field.
* @param parentNode the parent node of the node to be created
*/
Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.java?rev=1634308&r1=1634307&r2=1634308&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.java Sun Oct 26 11:56:59 2014
@@ -374,7 +374,7 @@ public abstract class PDFieldTreeNode im
/**
* Set the parent of this field.
*
- * @param parent The parent to this field.
+ * @param parentNode The parent to this field.
*/
public void setParent(PDFieldTreeNode parentNode)
{
@@ -600,6 +600,7 @@ public abstract class PDFieldTreeNode im
* Creates a COSField subclass from the given field.
* @param form the form that the field is part of
* @param field the dictionary representing a field element
+ * @param parentNode the parent node of the node to be created
* @return the corresponding PDField instance
*/
public static PDFieldTreeNode createField(PDAcroForm form, COSDictionary field, PDFieldTreeNode parentNode)
Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDTextField.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDTextField.java?rev=1634308&r1=1634307&r2=1634308&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDTextField.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDTextField.java Sun Oct 26 11:56:59 2014
@@ -29,7 +29,7 @@ import org.apache.pdfbox.cos.COSString;
public final class PDTextField extends PDVariableText
{
/**
- * @see PDFieldTreeNode#PDFieldTreeNode(PDAcroForm)(PDAcroForm,COSDictionary)
+ * @see PDFieldTreeNode#PDFieldTreeNode(PDAcroForm)
*
* @param theAcroForm The acroform.
*/