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 2016/06/23 19:00:16 UTC
svn commit: r1749973 - in /pdfbox/trunk:
pdfbox/src/main/java/org/apache/pdfbox/multipdf/
pdfbox/src/main/java/org/apache/pdfbox/pdmodel/encryption/
pdfbox/src/main/java/org/apache/pdfbox/pdmodel/fdf/
pdfbox/src/main/java/org/apache/pdfbox/pdmodel/inte...
Author: tilman
Date: Thu Jun 23 19:00:16 2016
New Revision: 1749973
URL: http://svn.apache.org/viewvc?rev=1749973&view=rev
Log:
PDFBOX-2852: fix javadoc
Modified:
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/multipdf/PDFCloneUtility.java
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/encryption/PDEncryption.java
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/fdf/FDFField.java
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDAcroForm.java
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDChoice.java
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDRadioButton.java
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.java
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/text/PDFTextStripper.java
pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/Encrypt.java
pdfbox/trunk/xmpbox/src/main/java/org/apache/xmpbox/XMPMetadata.java
Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/multipdf/PDFCloneUtility.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/multipdf/PDFCloneUtility.java?rev=1749973&r1=1749972&r2=1749973&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/multipdf/PDFCloneUtility.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/multipdf/PDFCloneUtility.java Thu Jun 23 19:00:16 2016
@@ -149,7 +149,7 @@ public class PDFCloneUtility
/**
* Merges two objects of the same type by deep-cloning its members.
- * <br/>
+ * <br>
* Base and target must be instances of the same class.
* @param base the base object to be cloned
* @param target the merge target
Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/encryption/PDEncryption.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/encryption/PDEncryption.java?rev=1749973&r1=1749972&r2=1749973&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/encryption/PDEncryption.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/encryption/PDEncryption.java Thu Jun 23 19:00:16 2016
@@ -180,8 +180,8 @@ public class PDEncryption
}
/**
- * This will set the V entry of the encryption dictionary.<br /><br />
- * See PDF Reference 1.4 Table 3.13. <br /><br/>
+ * This will set the V entry of the encryption dictionary.<br><br>
+ * See PDF Reference 1.4 Table 3.13. <br><br>
* <b>Note: This value is used to decrypt the pdf document. If you change this when
* the document is encrypted then decryption will fail!.</b>
*
@@ -193,7 +193,7 @@ public class PDEncryption
}
/**
- * This will return the V entry of the encryption dictionary.<br /><br />
+ * This will return the V entry of the encryption dictionary.<br><br>
* See PDF Reference 1.4 Table 3.13.
*
* @return The encryption version to use.
Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/fdf/FDFField.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/fdf/FDFField.java?rev=1749973&r1=1749972&r2=1749973&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/fdf/FDFField.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/fdf/FDFField.java Thu Jun 23 19:00:16 2016
@@ -187,9 +187,9 @@ public class FDFField implements COSObje
/**
* This will get the "T" entry in the field dictionary. A partial field name. Where the fully qualified field name
- * is a concatenation of the parent's fully qualified field name and "." as a separator. For example<br/>
- * Address.State<br />
- * Address.City<br />
+ * is a concatenation of the parent's fully qualified field name and "." as a separator. For example<br>
+ * Address.State<br>
+ * Address.City<br>
*
* @return The partial field name.
*/
Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDAcroForm.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDAcroForm.java?rev=1749973&r1=1749972&r2=1749973&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDAcroForm.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDAcroForm.java Thu Jun 23 19:00:16 2016
@@ -566,9 +566,9 @@ public final class PDAcroForm implements
/**
* This will get the 'quadding' or justification of the text to be displayed.
- * 0 - Left(default)<br/>
- * 1 - Centered<br />
- * 2 - Right<br />
+ * 0 - Left(default)<br>
+ * 1 - Centered<br>
+ * 2 - Right<br>
* Please see the QUADDING_CONSTANTS.
*
* @return The justification of the text strings.
Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDChoice.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDChoice.java?rev=1749973&r1=1749972&r2=1749973&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDChoice.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDChoice.java Thu Jun 23 19:00:16 2016
@@ -73,7 +73,7 @@ public abstract class PDChoice extends P
*
* <p>
* For a choice field the options array can either be an array
- * of text strings or an array of a two-element arrays.<br/>
+ * of text strings or an array of a two-element arrays.<br>
* The method always only returns either the text strings or,
* in case of two-element arrays, an array of the first element of
* the two-element arrays
@@ -180,7 +180,7 @@ public abstract class PDChoice extends P
*
* <p>
* For options with an array of text strings the display value and export value
- * are the same.<br/>
+ * are the same.<br>
* For options with an array of two-element arrays the display value is the
* second entry in the two-element array.
* </p>
@@ -198,7 +198,7 @@ public abstract class PDChoice extends P
*
* <p>
* For options with an array of text strings the display value and export value
- * are the same.<br/>
+ * are the same.<br>
* For options with an array of two-element arrays the export value is the
* first entry in the two-element array.
* </p>
Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDRadioButton.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDRadioButton.java?rev=1749973&r1=1749972&r2=1749973&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDRadioButton.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDRadioButton.java Thu Jun 23 19:00:16 2016
@@ -60,7 +60,7 @@ public final class PDRadioButton extends
}
/**
- * From the PDF Spec <br/>
+ * From the PDF Spec <br>
* If set, a group of radio buttons within a radio button field that use the same value for the on state will turn
* on and off in unison; that is if one is checked, they are all checked. If clear, the buttons are mutually
* exclusive (the same behavior as HTML radio buttons).
@@ -86,7 +86,7 @@ public final class PDRadioButton extends
* <p>
* A RadioButton might have an export value to allow field values
* which can not be encoded as PDFDocEncoding or for the same export value
- * being assigned to multiple RadioButtons in a group.<br/>
+ * being assigned to multiple RadioButtons in a group.<br>
* To define an export value the RadioButton must define options {@link #setExportValues(List)}
* which correspond to the individual items within the RadioButton.</p>
* <p>
Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.java?rev=1749973&r1=1749972&r2=1749973&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.java Thu Jun 23 19:00:16 2016
@@ -146,9 +146,9 @@ public abstract class PDVariableText ext
*
* This is an inheritable attribute.
*
- * 0 - Left(default)<br/>
- * 1 - Centered<br />
- * 2 - Right<br />
+ * 0 - Left(default)<br>
+ * 1 - Centered<br>
+ * 2 - Right<br>
* Please see the QUADDING_CONSTANTS.
*
* @return The justification of the text strings.
Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/text/PDFTextStripper.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/text/PDFTextStripper.java?rev=1749973&r1=1749972&r2=1749973&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/text/PDFTextStripper.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/text/PDFTextStripper.java Thu Jun 23 19:00:16 2016
@@ -1199,9 +1199,9 @@ public class PDFTextStripper extends PDF
/**
* The order of the text tokens in a PDF file may not be in the same as they appear visually on the screen. For
* example, a PDF writer may write out all text by font, so all bold or larger text, then make a second pass and
- * write out the normal text.<br/>
- * The default is to <b>not</b> sort by position.<br/>
- * <br/>
+ * write out the normal text.<br>
+ * The default is to <b>not</b> sort by position.<br>
+ * <br>
* A PDF writer could choose to write each character in a different order. By default PDFBox does <b>not</b> sort
* the text tokens before processing them due to performance reasons.
*
Modified: pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/Encrypt.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/Encrypt.java?rev=1749973&r1=1749972&r2=1749973&view=diff
==============================================================================
--- pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/Encrypt.java (original)
+++ pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/Encrypt.java Thu Jun 23 19:00:16 2016
@@ -32,7 +32,7 @@ import org.apache.pdfbox.pdmodel.encrypt
/**
* This will read a document from the filesystem, encrypt it and and then write
- * the results to the filesystem. <br/><br/>
+ * the results to the filesystem.
*
* @author Ben Litchfield
*/
Modified: pdfbox/trunk/xmpbox/src/main/java/org/apache/xmpbox/XMPMetadata.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/xmpbox/src/main/java/org/apache/xmpbox/XMPMetadata.java?rev=1749973&r1=1749972&r2=1749973&view=diff
==============================================================================
--- pdfbox/trunk/xmpbox/src/main/java/org/apache/xmpbox/XMPMetadata.java (original)
+++ pdfbox/trunk/xmpbox/src/main/java/org/apache/xmpbox/XMPMetadata.java Thu Jun 23 19:00:16 2016
@@ -207,10 +207,10 @@ public class XMPMetadata
/**
* Get the XMPSchema for the specified namespace.
*
- * Return the schema corresponding to this nsURI<br/>
+ * Return the schema corresponding to this nsURI<br>
* BE CAREFUL: typically, Metadata should contain one schema for each type.
* This method returns the first schema encountered
- * corresponding to this NSURI.<br/>
+ * corresponding to this NSURI.<br>
* Return null if unknown
*
* @param nsURI The namespace URI corresponding to the schema wanted
@@ -234,10 +234,10 @@ public class XMPMetadata
/**
* Get the XMPSchema for the specified Class.
*
- * Return the schema corresponding to this Class<br/>
+ * Return the schema corresponding to this Class<br>
* BE CAREFUL: typically, Metadata should contain one schema for each type.
* This method returns the first schema encountered
- * corresponding to this Class.<br/>
+ * corresponding to this Class.<br>
* Return null if unknown
*
* @param clz The Class corresponding to the schema wanted