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/06/21 11:26:09 UTC
svn commit: r1604327 - in
/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox: ./ cos/
pdfparser/ pdfwriter/ pdmodel/ pdmodel/documentinterchange/logicalstructure/
pdmodel/interactive/digitalsignature/visible/ pdmodel/interactive/form/
Author: msahyoun
Date: Sat Jun 21 09:26:08 2014
New Revision: 1604327
URL: http://svn.apache.org/r1604327
Log:
PDFBOX-2155 Fix JavaDocs warnings
Modified:
pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/WriteDecodedDoc.java
pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/cos/COSDocument.java
pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdfparser/NonSequentialPDFParser.java
pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdfparser/PDFXRefStream.java
pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdfparser/XrefTrailerResolver.java
pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdfwriter/COSStandardOutputStream.java
pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDResources.java
pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/documentinterchange/logicalstructure/PDUserProperty.java
pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/visible/PDVisibleSigProperties.java
pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDSignatureField.java
Modified: pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/WriteDecodedDoc.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/WriteDecodedDoc.java?rev=1604327&r1=1604326&r2=1604327&view=diff
==============================================================================
--- pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/WriteDecodedDoc.java (original)
+++ pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/WriteDecodedDoc.java Sat Jun 21 09:26:08 2014
@@ -58,7 +58,7 @@ public class WriteDecodedDoc
* @throws IOException If there is an error parsing the document.
* @throws COSVisitorException If there is an error while copying the document.
*
- * @deprecated use {@link WriteDecodedDoc#doIt(String, String, String)} instead.
+ * @deprecated use {@link WriteDecodedDoc#doIt(String, String, String, boolean)} instead.
*/
public void doIt(String in, String out) throws IOException, COSVisitorException
{
Modified: pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/cos/COSDocument.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/cos/COSDocument.java?rev=1604327&r1=1604326&r2=1604327&view=diff
==============================================================================
--- pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/cos/COSDocument.java (original)
+++ pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/cos/COSDocument.java Sat Jun 21 09:26:08 2014
@@ -357,7 +357,7 @@ public class COSDocument extends COSBase
}
/** Signals that the document is decrypted completely.
- * Needed e.g. by {@link NonSequentialPDFParser} to circumvent
+ * Needed e.g. by {@link org.apache.pdfbox.pdfparser.NonSequentialPDFParser} to circumvent
* additional decryption later on. */
public void setDecrypted()
{
Modified: pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdfparser/NonSequentialPDFParser.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdfparser/NonSequentialPDFParser.java?rev=1604327&r1=1604326&r2=1604327&view=diff
==============================================================================
--- pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdfparser/NonSequentialPDFParser.java (original)
+++ pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdfparser/NonSequentialPDFParser.java Sat Jun 21 09:26:08 2014
@@ -271,7 +271,7 @@ public class NonSequentialPDFParser exte
* be deleted at end of the parse method
*
* @param input
- * @return
+ * @return the temporary file
* @throws IOException If something went wrong.
*/
private File createTmpFile(InputStream input) throws IOException
@@ -1761,7 +1761,7 @@ public class NonSequentialPDFParser exte
/**
*
* @param startXRefOffset
- * @return
+ * @return the calculated offset
* @throws IOException
*/
private long calculateFixingOffset(long startXRefOffset) throws IOException
Modified: pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdfparser/PDFXRefStream.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdfparser/PDFXRefStream.java?rev=1604327&r1=1604326&r2=1604327&view=diff
==============================================================================
--- pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdfparser/PDFXRefStream.java (original)
+++ pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdfparser/PDFXRefStream.java Sat Jun 21 09:26:08 2014
@@ -161,7 +161,7 @@ public class PDFXRefStream implements PD
/**
* determines the minimal length required for all the lengths.
*
- * @return
+ * @return the length information
*/
private int[] getWEntry()
{
Modified: pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdfparser/XrefTrailerResolver.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdfparser/XrefTrailerResolver.java?rev=1604327&r1=1604326&r2=1604327&view=diff
==============================================================================
--- pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdfparser/XrefTrailerResolver.java (original)
+++ pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdfparser/XrefTrailerResolver.java Sat Jun 21 09:26:08 2014
@@ -42,7 +42,7 @@ import org.apache.pdfbox.persistence.uti
* XRef/trailer objects are used to create xref table / trailer dictionary
* in order they occur.
*
- * For each new xref object/XRef stream method {@link #nextXrefObj(long, XRefType)}
+ * For each new xref object/XRef stream method {@link #nextXrefObj(long)}
* must be called with start byte position. All following calls to
* {@link #setXRef(COSObjectKey, long)} or {@link #setTrailer(COSDictionary)}
* will add the data for this byte position.
@@ -248,7 +248,7 @@ public class XrefTrailerResolver
/**
* Gets the resolved trailer. Might return <code>null</code> in case
- * {@link #setStartxref(int)} was not called before.
+ * {@link #setStartxref(long)} was not called before.
*
* @return the trailer if available
*/
@@ -259,7 +259,7 @@ public class XrefTrailerResolver
/**
* Gets the resolved xref table. Might return <code>null</code> in case
- * {@link #setStartxref(int)} was not called before.
+ * {@link #setStartxref(long)} was not called before.
*
* @return the xrefTable if available
*/
Modified: pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdfwriter/COSStandardOutputStream.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdfwriter/COSStandardOutputStream.java?rev=1604327&r1=1604326&r2=1604327&view=diff
==============================================================================
--- pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdfwriter/COSStandardOutputStream.java (original)
+++ pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdfwriter/COSStandardOutputStream.java Sat Jun 21 09:26:08 2014
@@ -94,7 +94,7 @@ public class COSStandardOutputStream ext
/**
* This will set the current position in the stream.
*
- * @param The to be set position in the stream.
+ * @param pos the to be set position in the stream.
* @throws IOException
*/
public void setPos(long pos) throws IOException
Modified: pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDResources.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDResources.java?rev=1604327&r1=1604326&r2=1604327&view=diff
==============================================================================
--- pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDResources.java (original)
+++ pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDResources.java Sat Jun 21 09:26:08 2014
@@ -44,6 +44,7 @@ import org.apache.pdfbox.util.MapUtil;
* This represents a set of resources available at the page/pages/stream level.
*
* @author <a href="mailto:ben@benlitchfield.com">Ben Litchfield</a>
+ * @author BM
*
*/
public class PDResources implements COSObjectable
@@ -274,7 +275,6 @@ public class PDResources implements COSO
* This will get the map of images. An empty map will be returned if there are no underlying images. So far the keys
* are COSName of the image and the value is the corresponding PDXObjectImage.
*
- * @author By BM
* @return The map of images.
* @throws IOException If there is an error writing the picture.
*
Modified: pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/documentinterchange/logicalstructure/PDUserProperty.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/documentinterchange/logicalstructure/PDUserProperty.java?rev=1604327&r1=1604326&r2=1604327&view=diff
==============================================================================
--- pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/documentinterchange/logicalstructure/PDUserProperty.java (original)
+++ pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/documentinterchange/logicalstructure/PDUserProperty.java Sat Jun 21 09:26:08 2014
@@ -46,7 +46,7 @@ public class PDUserProperty extends PDDi
* Creates a user property with a given dictionary.
*
* @param dictionary the dictionary
- * @param the user attribute object
+ * @param userAttributeObject the user attribute object
*/
public PDUserProperty(COSDictionary dictionary,
PDUserAttributeObject userAttributeObject)
Modified: pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/visible/PDVisibleSigProperties.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/visible/PDVisibleSigProperties.java?rev=1604327&r1=1604326&r2=1604327&view=diff
==============================================================================
--- pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/visible/PDVisibleSigProperties.java (original)
+++ pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/visible/PDVisibleSigProperties.java Sat Jun 21 09:26:08 2014
@@ -91,7 +91,7 @@ public class PDVisibleSigProperties
/**
* gets reason of signing
- * @return
+ * @return the reason of signing
*/
public String getSignatureReason()
{
Modified: pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDSignatureField.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDSignatureField.java?rev=1604327&r1=1604326&r2=1604327&view=diff
==============================================================================
--- pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDSignatureField.java (original)
+++ pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDSignatureField.java Sat Jun 21 09:26:08 2014
@@ -73,7 +73,7 @@ public class PDSignatureField extends PD
/**
* Generate a unique name for the signature.
- * @return
+ * @return the unique name for the signature
* @throws IOException If there is an error while getting the list of fields.
*/
private String generatePartialName() throws IOException