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/24 19:39:02 UTC
svn commit: r1750160 - in /pdfbox/branches/2.0:
examples/src/main/java/org/apache/pdfbox/examples/interactive/form/
examples/src/main/java/org/apache/pdfbox/examples/pdmodel/
pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/
pdfbox/src/main/java/o...
Author: tilman
Date: Fri Jun 24 19:39:01 2016
New Revision: 1750160
URL: http://svn.apache.org/viewvc?rev=1750160&view=rev
Log:
PDFBOX-2852: fix javadoc
Modified:
pdfbox/branches/2.0/examples/src/main/java/org/apache/pdfbox/examples/interactive/form/PrintFields.java
pdfbox/branches/2.0/examples/src/main/java/org/apache/pdfbox/examples/interactive/form/SetField.java
pdfbox/branches/2.0/examples/src/main/java/org/apache/pdfbox/examples/pdmodel/AddImageToPDF.java
pdfbox/branches/2.0/examples/src/main/java/org/apache/pdfbox/examples/pdmodel/AddMessageToEachPage.java
pdfbox/branches/2.0/examples/src/main/java/org/apache/pdfbox/examples/pdmodel/EmbeddedFiles.java
pdfbox/branches/2.0/examples/src/main/java/org/apache/pdfbox/examples/pdmodel/PrintURLs.java
pdfbox/branches/2.0/examples/src/main/java/org/apache/pdfbox/examples/pdmodel/ReplaceURLs.java
pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/PDRectangle.java
pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/encryption/PDCryptFilterDictionary.java
pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/encryption/PDEncryption.java
pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/fdf/FDFField.java
pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/fdf/FDFIconFit.java
pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/text/PDFTextStripper.java
pdfbox/branches/2.0/tools/src/main/java/org/apache/pdfbox/tools/ExportFDF.java
pdfbox/branches/2.0/tools/src/main/java/org/apache/pdfbox/tools/ExportXFDF.java
pdfbox/branches/2.0/tools/src/main/java/org/apache/pdfbox/tools/ImportFDF.java
pdfbox/branches/2.0/tools/src/main/java/org/apache/pdfbox/tools/ImportXFDF.java
pdfbox/branches/2.0/tools/src/main/java/org/apache/pdfbox/tools/TextToPDF.java
pdfbox/branches/2.0/tools/src/main/java/org/apache/pdfbox/tools/WriteDecodedDoc.java
Modified: pdfbox/branches/2.0/examples/src/main/java/org/apache/pdfbox/examples/interactive/form/PrintFields.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/examples/src/main/java/org/apache/pdfbox/examples/interactive/form/PrintFields.java?rev=1750160&r1=1750159&r2=1750160&view=diff
==============================================================================
--- pdfbox/branches/2.0/examples/src/main/java/org/apache/pdfbox/examples/interactive/form/PrintFields.java (original)
+++ pdfbox/branches/2.0/examples/src/main/java/org/apache/pdfbox/examples/interactive/form/PrintFields.java Fri Jun 24 19:39:01 2016
@@ -91,7 +91,7 @@ public class PrintFields
}
/**
- * This will read a PDF file and print out the form elements. <br />
+ * This will read a PDF file and print out the form elements. <br>
* see usage() for commandline
*
* @param args command line arguments
Modified: pdfbox/branches/2.0/examples/src/main/java/org/apache/pdfbox/examples/interactive/form/SetField.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/examples/src/main/java/org/apache/pdfbox/examples/interactive/form/SetField.java?rev=1750160&r1=1750159&r2=1750160&view=diff
==============================================================================
--- pdfbox/branches/2.0/examples/src/main/java/org/apache/pdfbox/examples/interactive/form/SetField.java (original)
+++ pdfbox/branches/2.0/examples/src/main/java/org/apache/pdfbox/examples/interactive/form/SetField.java Fri Jun 24 19:39:01 2016
@@ -81,7 +81,7 @@ public class SetField
/**
* This will read a PDF file and set a field and then write it the pdf out
- * again. <br />
+ * again. <br>
* see usage() for commandline
*
* @param args command line arguments
Modified: pdfbox/branches/2.0/examples/src/main/java/org/apache/pdfbox/examples/pdmodel/AddImageToPDF.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/examples/src/main/java/org/apache/pdfbox/examples/pdmodel/AddImageToPDF.java?rev=1750160&r1=1750159&r2=1750160&view=diff
==============================================================================
--- pdfbox/branches/2.0/examples/src/main/java/org/apache/pdfbox/examples/pdmodel/AddImageToPDF.java (original)
+++ pdfbox/branches/2.0/examples/src/main/java/org/apache/pdfbox/examples/pdmodel/AddImageToPDF.java Fri Jun 24 19:39:01 2016
@@ -80,7 +80,7 @@ public class AddImageToPDF
/**
* This will load a PDF document and add a single image on it.
- * <br />
+ * <br>
* see usage() for commandline
*
* @param args Command line arguments.
Modified: pdfbox/branches/2.0/examples/src/main/java/org/apache/pdfbox/examples/pdmodel/AddMessageToEachPage.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/examples/src/main/java/org/apache/pdfbox/examples/pdmodel/AddMessageToEachPage.java?rev=1750160&r1=1750159&r2=1750160&view=diff
==============================================================================
--- pdfbox/branches/2.0/examples/src/main/java/org/apache/pdfbox/examples/pdmodel/AddMessageToEachPage.java (original)
+++ pdfbox/branches/2.0/examples/src/main/java/org/apache/pdfbox/examples/pdmodel/AddMessageToEachPage.java Fri Jun 24 19:39:01 2016
@@ -109,7 +109,7 @@ public class AddMessageToEachPage
/**
* This will create a hello world PDF document.
- * <br />
+ * <br>
* see usage() for commandline
*
* @param args Command line arguments.
Modified: pdfbox/branches/2.0/examples/src/main/java/org/apache/pdfbox/examples/pdmodel/EmbeddedFiles.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/examples/src/main/java/org/apache/pdfbox/examples/pdmodel/EmbeddedFiles.java?rev=1750160&r1=1750159&r2=1750160&view=diff
==============================================================================
--- pdfbox/branches/2.0/examples/src/main/java/org/apache/pdfbox/examples/pdmodel/EmbeddedFiles.java (original)
+++ pdfbox/branches/2.0/examples/src/main/java/org/apache/pdfbox/examples/pdmodel/EmbeddedFiles.java Fri Jun 24 19:39:01 2016
@@ -120,7 +120,7 @@ public class EmbeddedFiles
/**
* This will create a hello world PDF document with an embedded file.
- * <br />
+ * <br>
* see usage() for commandline
*
* @param args Command line arguments.
Modified: pdfbox/branches/2.0/examples/src/main/java/org/apache/pdfbox/examples/pdmodel/PrintURLs.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/examples/src/main/java/org/apache/pdfbox/examples/pdmodel/PrintURLs.java?rev=1750160&r1=1750159&r2=1750160&view=diff
==============================================================================
--- pdfbox/branches/2.0/examples/src/main/java/org/apache/pdfbox/examples/pdmodel/PrintURLs.java (original)
+++ pdfbox/branches/2.0/examples/src/main/java/org/apache/pdfbox/examples/pdmodel/PrintURLs.java Fri Jun 24 19:39:01 2016
@@ -48,7 +48,7 @@ public final class PrintURLs
/**
* This will create a hello world PDF document.
- * <br />
+ * <br>
* see usage() for commandline
*
* @param args Command line arguments.
Modified: pdfbox/branches/2.0/examples/src/main/java/org/apache/pdfbox/examples/pdmodel/ReplaceURLs.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/examples/src/main/java/org/apache/pdfbox/examples/pdmodel/ReplaceURLs.java?rev=1750160&r1=1750159&r2=1750160&view=diff
==============================================================================
--- pdfbox/branches/2.0/examples/src/main/java/org/apache/pdfbox/examples/pdmodel/ReplaceURLs.java (original)
+++ pdfbox/branches/2.0/examples/src/main/java/org/apache/pdfbox/examples/pdmodel/ReplaceURLs.java Fri Jun 24 19:39:01 2016
@@ -48,7 +48,7 @@ public final class ReplaceURLs
/**
* This will read in a document and replace all of the urls with
* http://pdfbox.apache.org.
- * <br />
+ * <br>
* see usage() for commandline
*
* @param args Command line arguments.
Modified: pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/PDRectangle.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/PDRectangle.java?rev=1750160&r1=1750159&r2=1750160&view=diff
==============================================================================
--- pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/PDRectangle.java (original)
+++ pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/PDRectangle.java Fri Jun 24 19:39:01 2016
@@ -156,8 +156,8 @@ public class PDRectangle implements COSO
/**
* This will create a translated rectangle based off of this rectangle, such
* that the new rectangle retains the same dimensions(height/width), but the
- * lower left x,y values are zero. <br />
- * 100, 100, 400, 400 (llx, lly, urx, ury ) <br />
+ * lower left x,y values are zero. <br>
+ * 100, 100, 400, 400 (llx, lly, urx, ury ) <br>
* will be translated to 0,0,300,300
*
* @return A new rectangle that has been translated back to the origin.
Modified: pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/encryption/PDCryptFilterDictionary.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/encryption/PDCryptFilterDictionary.java?rev=1750160&r1=1750159&r2=1750160&view=diff
==============================================================================
--- pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/encryption/PDCryptFilterDictionary.java (original)
+++ pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/encryption/PDCryptFilterDictionary.java Fri Jun 24 19:39:01 2016
@@ -72,7 +72,7 @@ public class PDCryptFilterDictionary
}
/**
- * This will return the Length entry of the crypt filter dictionary.<br /><br />
+ * This will return the Length entry of the crypt filter dictionary.<br><br>
* The length in <b>bits</b> for the crypt filter algorithm. This will return a multiple of 8.
*
* @return The length in bits for the encryption algorithm
Modified: pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/encryption/PDEncryption.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/encryption/PDEncryption.java?rev=1750160&r1=1750159&r2=1750160&view=diff
==============================================================================
--- pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/encryption/PDEncryption.java (original)
+++ pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/encryption/PDEncryption.java Fri Jun 24 19:39:01 2016
@@ -214,7 +214,7 @@ public class PDEncryption
}
/**
- * This will return the Length entry of the encryption dictionary.<br /><br />
+ * This will return the Length entry of the encryption dictionary.<br><br>
* The length in <b>bits</b> for the encryption algorithm. This will return a multiple of 8.
*
* @return The length in bits for the encryption algorithm
@@ -225,8 +225,8 @@ public class PDEncryption
}
/**
- * This will set the R entry of the encryption dictionary.<br /><br />
- * See PDF Reference 1.4 Table 3.14. <br /><br/>
+ * This will set the R entry of the encryption dictionary.<br><br>
+ * See PDF Reference 1.4 Table 3.14. <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>
@@ -239,7 +239,7 @@ public class PDEncryption
}
/**
- * This will return the R entry of the encryption dictionary.<br /><br />
+ * This will return the R entry of the encryption dictionary.<br><br>
* See PDF Reference 1.4 Table 3.14.
*
* @return The encryption revision to use.
Modified: pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/fdf/FDFField.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/fdf/FDFField.java?rev=1750160&r1=1750159&r2=1750160&view=diff
==============================================================================
--- pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/fdf/FDFField.java (original)
+++ pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/fdf/FDFField.java Fri Jun 24 19:39:01 2016
@@ -209,8 +209,8 @@ public class FDFField implements COSObje
}
/**
- * This will get the value for the field. This will return type will either be <br />
- * String : Checkboxes, Radio Button <br />
+ * This will get the value for the field. This will return type will either be <br>
+ * String : Checkboxes, Radio Button <br>
* java.util.List of strings: Choice Field PDTextStream: Textfields
*
* @return The value of the field.
Modified: pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/fdf/FDFIconFit.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/fdf/FDFIconFit.java?rev=1750160&r1=1750159&r2=1750160&view=diff
==============================================================================
--- pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/fdf/FDFIconFit.java (original)
+++ pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/fdf/FDFIconFit.java Fri Jun 24 19:39:01 2016
@@ -139,7 +139,7 @@ public class FDFIconFit implements COSOb
}
/**
- * This is guaranteed to never return null.<br />
+ * This is guaranteed to never return null.<br>
*
* To quote the PDF Spec "An array of two numbers between 0.0 and 1.0 indicating the fraction of leftover space to
* allocate at the left and bottom of the icon. A value of [0.0 0.0] positions the icon at the bottom-left corner of
Modified: pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/text/PDFTextStripper.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/text/PDFTextStripper.java?rev=1750160&r1=1750159&r2=1750160&view=diff
==============================================================================
--- pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/text/PDFTextStripper.java (original)
+++ pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/text/PDFTextStripper.java Fri Jun 24 19:39:01 2016
@@ -214,7 +214,7 @@ public class PDFTextStripper extends PDF
}
/**
- * This will return the text of a document. See writeText. <br />
+ * This will return the text of a document. See writeText. <br>
* NOTE: The document must not be encrypted when coming into this method.
*
* @param doc The document to get the text from.
Modified: pdfbox/branches/2.0/tools/src/main/java/org/apache/pdfbox/tools/ExportFDF.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/tools/src/main/java/org/apache/pdfbox/tools/ExportFDF.java?rev=1750160&r1=1750159&r2=1750160&view=diff
==============================================================================
--- pdfbox/branches/2.0/tools/src/main/java/org/apache/pdfbox/tools/ExportFDF.java (original)
+++ pdfbox/branches/2.0/tools/src/main/java/org/apache/pdfbox/tools/ExportFDF.java Fri Jun 24 19:39:01 2016
@@ -40,7 +40,7 @@ public class ExportFDF
/**
* This will import an fdf document and write out another pdf.
- * <br />
+ * <br>
* see usage() for commandline
*
* @param args command line arguments
Modified: pdfbox/branches/2.0/tools/src/main/java/org/apache/pdfbox/tools/ExportXFDF.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/tools/src/main/java/org/apache/pdfbox/tools/ExportXFDF.java?rev=1750160&r1=1750159&r2=1750160&view=diff
==============================================================================
--- pdfbox/branches/2.0/tools/src/main/java/org/apache/pdfbox/tools/ExportXFDF.java (original)
+++ pdfbox/branches/2.0/tools/src/main/java/org/apache/pdfbox/tools/ExportXFDF.java Fri Jun 24 19:39:01 2016
@@ -40,7 +40,7 @@ public class ExportXFDF
/**
* This will import an fdf document and write out another pdf.
- * <br />
+ * <br>
* see usage() for commandline
*
* @param args command line arguments
Modified: pdfbox/branches/2.0/tools/src/main/java/org/apache/pdfbox/tools/ImportFDF.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/tools/src/main/java/org/apache/pdfbox/tools/ImportFDF.java?rev=1750160&r1=1750159&r2=1750160&view=diff
==============================================================================
--- pdfbox/branches/2.0/tools/src/main/java/org/apache/pdfbox/tools/ImportFDF.java (original)
+++ pdfbox/branches/2.0/tools/src/main/java/org/apache/pdfbox/tools/ImportFDF.java Fri Jun 24 19:39:01 2016
@@ -65,7 +65,7 @@ public class ImportFDF
/**
* This will import an fdf document and write out another pdf.
- * <br />
+ * <br>
* see usage() for commandline
*
* @param args command line arguments
Modified: pdfbox/branches/2.0/tools/src/main/java/org/apache/pdfbox/tools/ImportXFDF.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/tools/src/main/java/org/apache/pdfbox/tools/ImportXFDF.java?rev=1750160&r1=1750159&r2=1750160&view=diff
==============================================================================
--- pdfbox/branches/2.0/tools/src/main/java/org/apache/pdfbox/tools/ImportXFDF.java (original)
+++ pdfbox/branches/2.0/tools/src/main/java/org/apache/pdfbox/tools/ImportXFDF.java Fri Jun 24 19:39:01 2016
@@ -59,7 +59,7 @@ public class ImportXFDF
/**
* This will import an fdf document and write out another pdf.
- * <br />
+ * <br>
* see usage() for commandline
*
* @param args command line arguments
Modified: pdfbox/branches/2.0/tools/src/main/java/org/apache/pdfbox/tools/TextToPDF.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/tools/src/main/java/org/apache/pdfbox/tools/TextToPDF.java?rev=1750160&r1=1750159&r2=1750160&view=diff
==============================================================================
--- pdfbox/branches/2.0/tools/src/main/java/org/apache/pdfbox/tools/TextToPDF.java (original)
+++ pdfbox/branches/2.0/tools/src/main/java/org/apache/pdfbox/tools/TextToPDF.java Fri Jun 24 19:39:01 2016
@@ -210,7 +210,7 @@ public class TextToPDF
/**
* This will create a PDF document with some text in it.
- * <br />
+ * <br>
* see usage() for commandline
*
* @param args Command line arguments.
Modified: pdfbox/branches/2.0/tools/src/main/java/org/apache/pdfbox/tools/WriteDecodedDoc.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/tools/src/main/java/org/apache/pdfbox/tools/WriteDecodedDoc.java?rev=1750160&r1=1750159&r2=1750160&view=diff
==============================================================================
--- pdfbox/branches/2.0/tools/src/main/java/org/apache/pdfbox/tools/WriteDecodedDoc.java (original)
+++ pdfbox/branches/2.0/tools/src/main/java/org/apache/pdfbox/tools/WriteDecodedDoc.java Fri Jun 24 19:39:01 2016
@@ -89,7 +89,7 @@ public class WriteDecodedDoc
/**
* This will write a PDF document with completely decoded streams.
- * <br />
+ * <br>
* see usage() for commandline
*
* @param args command line arguments