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/04/22 13:13:41 UTC
svn commit: r1589086 - in /pdfbox/branches/1.8: ./
pdfbox/src/main/java/org/apache/pdfbox/pdfparser/
pdfbox/src/main/java/org/apache/pdfbox/pdfviewer/
pdfbox/src/main/java/org/apache/pdfbox/pdfwriter/
pdfbox/src/main/java/org/apache/pdfbox/pdmodel/ pdf...
Author: msahyoun
Date: Tue Apr 22 11:13:40 2014
New Revision: 1589086
URL: http://svn.apache.org/r1589086
Log:
[PDFBOX-1897] fixing errors in javadoc comments
Modified:
pdfbox/branches/1.8/ (props changed)
pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdfparser/ConformingPDFParser.java
pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdfparser/PDFStreamParser.java
pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdfparser/VisualSignatureParser.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/pdfviewer/PageDrawer.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/ConformingPDDocument.java
pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocumentInformation.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/common/COSArrayList.java
pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/PDPageLabels.java
pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/function/PDFunction.java
pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/function/PDFunctionType2.java
pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/documentinterchange/logicalstructure/PDMarkedContentReference.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/documentinterchange/taggedpdf/PDExportFormatAttributeObject.java
pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/documentinterchange/taggedpdf/PDLayoutAttributeObject.java
pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/encryption/PublicKeySecurityHandler.java
pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/encryption/SecurityHandler.java
pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/PDFontDescriptor.java
pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/pattern/PDPatternResources.java
pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/shading/AxialShadingPaint.java
pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/shading/PDShadingType1.java
pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/shading/RadialShadingPaint.java
pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/xobject/PDXObject.java
pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/SignatureOptions.java
pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/visible/PDFTemplateStructure.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/digitalsignature/visible/PDVisibleSignDesigner.java
pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/documentnavigation/destination/PDPageDestination.java
pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDPushButton.java
pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/util/BitFlagHelper.java
pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/util/DateConverter.java
pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/util/ICU4JImpl.java
pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/util/PDFImageWriter.java
pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/util/PageExtractor.java
pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/util/TextPosition.java
Propchange: pdfbox/branches/1.8/
------------------------------------------------------------------------------
Merged /pdfbox/trunk:r1566286
Modified: pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdfparser/ConformingPDFParser.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdfparser/ConformingPDFParser.java?rev=1589086&r1=1589085&r2=1589086&view=diff
==============================================================================
--- pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdfparser/ConformingPDFParser.java (original)
+++ pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdfparser/ConformingPDFParser.java Tue Apr 22 11:13:40 2014
@@ -55,7 +55,7 @@ public class ConformingPDFParser extends
/**
* Constructor.
*
- * @param input The input stream that contains the PDF document.
+ * @param inputFile The input stream that contains the PDF document.
*
* @throws IOException If there is an error initializing the stream.
*/
@@ -365,7 +365,7 @@ public class ConformingPDFParser extends
* exception will be thrown.
* @param objectNumber the object number you expect to read
* @param generation the generation you expect this object to be
- * @return
+ * @return the object being read.
*/
public COSBase readObject(long objectNumber, long generation) throws IOException {
// when recursivly reading, we always pull the object from the filesystem
@@ -598,7 +598,6 @@ public class ConformingPDFParser extends
* backwards until it finds a newline. This should only be used if we are
* certain that the data will only be text, and not binary data.
*
- * @param offset the location of the file where we should start reading
* @return the string which was read
* @throws IOException if there was an error reading data from the file
*/
@@ -629,7 +628,6 @@ public class ConformingPDFParser extends
* This will read a line starting with the byte at offset and going
* forward until it finds a newline. This should only be used if we are
* certain that the data will only be text, and not binary data.
- * @param offset the location of the file where we should start reading
* @return the string which was read
* @throws IOException if there was an error reading data from the file
*/
Modified: pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdfparser/PDFStreamParser.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdfparser/PDFStreamParser.java?rev=1589086&r1=1589085&r2=1589086&view=diff
==============================================================================
--- pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdfparser/PDFStreamParser.java (original)
+++ pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdfparser/PDFStreamParser.java Tue Apr 22 11:13:40 2014
@@ -156,7 +156,9 @@ public class PDFStreamParser extends Bas
}
/**
- * {@inheritDoc}
+ * This will close the underlying pdfSource object.
+ *
+ * @throws IOException If there is an error releasing resources.
*/
public void close() throws IOException
{
Modified: pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdfparser/VisualSignatureParser.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdfparser/VisualSignatureParser.java?rev=1589086&r1=1589085&r2=1589086&view=diff
==============================================================================
--- pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdfparser/VisualSignatureParser.java (original)
+++ pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdfparser/VisualSignatureParser.java Tue Apr 22 11:13:40 2014
@@ -50,7 +50,9 @@ public class VisualSignatureParser exten
}
/**
- * {@inheritDoc}
+ * This will parse the tokens making up the visual signature.
+ *
+ * @throws IOException If there is an error while parsing the visual signature.
*/
public void parse() throws IOException
{
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=1589086&r1=1589085&r2=1589086&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 Tue Apr 22 11:13:40 2014
@@ -42,13 +42,13 @@ 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(int)}
+ * For each new xref object/XRef stream method {@link #nextXrefObj(long, XRefType)}
* must be called with start byte position. All following calls to
- * {@link #setXRef(COSObjectKey, int)} or {@link #setTrailer(COSDictionary)}
+ * {@link #setXRef(COSObjectKey, long)} or {@link #setTrailer(COSDictionary)}
* will add the data for this byte position.
*
* After all objects are parsed the startxref position must be provided
- * using {@link #setStartxref(int)}. This is used to build the chain of
+ * using {@link #setStartxref(long)}. This is used to build the chain of
* active xref/trailer objects used for creating document trailer and xref table.
*
* @author Timo Böhme (timo.boehme at ontochem.com)
@@ -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/pdfviewer/PageDrawer.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdfviewer/PageDrawer.java?rev=1589086&r1=1589085&r2=1589086&view=diff
==============================================================================
--- pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdfviewer/PageDrawer.java (original)
+++ pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdfviewer/PageDrawer.java Tue Apr 22 11:13:40 2014
@@ -553,7 +553,7 @@ public class PageDrawer extends PDFStrea
*
* @throws IOException If there is an IO error while shade-filling the path/clipping area.
*
- * @deprecated use {@link #shFill(COSName)) instead.
+ * @deprecated use {@link #shFill(COSName)} instead.
*/
public void SHFill(COSName ShadingName) throws IOException
{
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=1589086&r1=1589085&r2=1589086&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 Tue Apr 22 11:13:40 2014
@@ -92,9 +92,8 @@ public class COSStandardOutputStream ext
}
/**
- * This will get the current position in the stream.
+ * This will set the current position in the stream.
*
- * @return The current 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/ConformingPDDocument.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/ConformingPDDocument.java?rev=1589086&r1=1589085&r2=1589086&view=diff
==============================================================================
--- pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/ConformingPDDocument.java (original)
+++ pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/ConformingPDDocument.java Tue Apr 22 11:13:40 2014
@@ -73,7 +73,6 @@ public class ConformingPDDocument extend
/**
* This will get an object from the pool.
- * @param key The object key.
* @return The object in the pool or a new one if it has not been parsed yet.
* @throws IOException If there is an error getting the proxy object.
*/
Modified: pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocumentInformation.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocumentInformation.java?rev=1589086&r1=1589085&r2=1589086&view=diff
==============================================================================
--- pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocumentInformation.java (original)
+++ pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocumentInformation.java Tue Apr 22 11:13:40 2014
@@ -34,6 +34,8 @@ import org.apache.pdfbox.pdmodel.common.
* method then it will clear the value.
*
* @author <a href="mailto:ben@benlitchfield.com">Ben Litchfield</a>
+ * @author Gerardo Ortiz
+ *
* @version $Revision: 1.12 $
*/
public class PDDocumentInformation implements COSObjectable
@@ -275,8 +277,6 @@ public class PDDocumentInformation imple
* @param fieldName Name of custom metadata field from pdf document.
*
* @return String Value of metadata field
- *
- * @author Gerardo Ortiz
*/
public String getCustomMetadataValue(String fieldName)
{
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=1589086&r1=1589085&r2=1589086&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 Tue Apr 22 11:13:40 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 By BM
*
*/
public class PDResources implements COSObjectable
@@ -266,7 +267,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/common/COSArrayList.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/COSArrayList.java?rev=1589086&r1=1589085&r2=1589086&view=diff
==============================================================================
--- pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/COSArrayList.java (original)
+++ pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/COSArrayList.java Tue Apr 22 11:13:40 2014
@@ -94,7 +94,7 @@ public class COSArrayList<E> implements
}
/**
- * @deprecated use the {@link #COSArrayList(E, COSBase, COSDictionary, COSName)} method instead
+ * @deprecated use the {@link #COSArrayList(Object, COSBase, COSDictionary, COSName)} method instead
*/
public COSArrayList( E actualObject, COSBase item, COSDictionary dictionary, String dictionaryKey )
{
Modified: pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/PDPageLabels.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/PDPageLabels.java?rev=1589086&r1=1589085&r2=1589086&view=diff
==============================================================================
--- pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/PDPageLabels.java (original)
+++ pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/PDPageLabels.java Tue Apr 22 11:13:40 2014
@@ -53,12 +53,12 @@ public class PDPageLabels implements COS
* <p>
* Note that the page label dictionary won't be automatically added to the
* document; you will still need to do it manually (see
- * {@link PDDocumentCatalog#setPageLabels(PDPageLabels)}.
+ * {@link org.apache.pdfbox.pdmodel.PDDocumentCatalog#setPageLabels(PDPageLabels)}.
* </p>
*
* @param document
* The document the page label dictionary is created for.
- * @see PDDocumentCatalog#setPageLabels(PDPageLabels)
+ * @see org.apache.pdfbox.pdmodel.PDDocumentCatalog#setPageLabels(PDPageLabels)
*/
public PDPageLabels(PDDocument document)
{
@@ -76,14 +76,14 @@ public class PDPageLabels implements COS
* <p>
* Note that the page label dictionary won't be automatically added to the
* document; you will still need to do it manually (see
- * {@link PDDocumentCatalog#setPageLabels(PDPageLabels)}.
+ * {@link org.apache.pdfbox.pdmodel.PDDocumentCatalog#setPageLabels(PDPageLabels)}.
* </p>
*
* @param document
* The document the page label dictionary is created for.
* @param dict
* an existing page label dictionary
- * @see PDDocumentCatalog#setPageLabels(PDPageLabels)
+ * @see org.apache.pdfbox.pdmodel.PDDocumentCatalog#setPageLabels(PDPageLabels)
* @throws IOException
* If something goes wrong during the number tree conversion.
*/
Modified: pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/function/PDFunction.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/function/PDFunction.java?rev=1589086&r1=1589085&r2=1589086&view=diff
==============================================================================
--- pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/function/PDFunction.java (original)
+++ pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/function/PDFunction.java Tue Apr 22 11:13:40 2014
@@ -316,7 +316,7 @@ public abstract class PDFunction impleme
/**
* Clip the given input values to the ranges.
*
- * @param inputArray the input values
+ * @param inputValues the input values
* @return the clipped values
*/
protected float[] clipToRange(float[] inputValues)
Modified: pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/function/PDFunctionType2.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/function/PDFunctionType2.java?rev=1589086&r1=1589085&r2=1589086&view=diff
==============================================================================
--- pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/function/PDFunctionType2.java (original)
+++ pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/function/PDFunctionType2.java Tue Apr 22 11:13:40 2014
@@ -45,7 +45,7 @@ public class PDFunctionType2 extends PDF
/**
* Constructor.
*
- * @param functionStream The function .
+ * @param function The function .
*/
public PDFunctionType2(COSBase function)
{
Modified: pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/documentinterchange/logicalstructure/PDMarkedContentReference.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/documentinterchange/logicalstructure/PDMarkedContentReference.java?rev=1589086&r1=1589085&r2=1589086&view=diff
==============================================================================
--- pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/documentinterchange/logicalstructure/PDMarkedContentReference.java (original)
+++ pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/documentinterchange/logicalstructure/PDMarkedContentReference.java Tue Apr 22 11:13:40 2014
@@ -52,8 +52,7 @@ public class PDMarkedContentReference im
/**
* Constructor for an existing marked content reference.
*
- * @param pageDic the page dictionary
- * @param mcid the marked content indentifier
+ * @param dictionary the page dictionary
*/
public PDMarkedContentReference(COSDictionary dictionary)
{
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=1589086&r1=1589085&r2=1589086&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 Tue Apr 22 11:13:40 2014
@@ -35,7 +35,7 @@ public class PDUserProperty extends PDDi
/**
* Creates a new user property.
*
- * @param the user attribute object
+ * @param userAttributeObject the user attribute object
*/
public PDUserProperty(PDUserAttributeObject userAttributeObject)
{
@@ -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/documentinterchange/taggedpdf/PDExportFormatAttributeObject.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/documentinterchange/taggedpdf/PDExportFormatAttributeObject.java?rev=1589086&r1=1589085&r2=1589086&view=diff
==============================================================================
--- pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/documentinterchange/taggedpdf/PDExportFormatAttributeObject.java (original)
+++ pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/documentinterchange/taggedpdf/PDExportFormatAttributeObject.java Tue Apr 22 11:13:40 2014
@@ -79,7 +79,7 @@ public class PDExportFormatAttributeObje
/**
* Gets the list numbering (ListNumbering). The default value is
- * {@link #LIST_NUMBERING_NONE}.
+ * {@link PDListAttributeObject#LIST_NUMBERING_NONE}.
*
* @return the list numbering
*/
@@ -93,15 +93,15 @@ public class PDExportFormatAttributeObje
* Sets the list numbering (ListNumbering). The value shall be one of the
* following:
* <ul>
- * <li>{@link #LIST_NUMBERING_NONE},</li>
- * <li>{@link #LIST_NUMBERING_DISC},</li>
- * <li>{@link #LIST_NUMBERING_CIRCLE},</li>
- * <li>{@link #LIST_NUMBERING_SQUARE},</li>
- * <li>{@link #LIST_NUMBERING_DECIMAL},</li>
- * <li>{@link #LIST_NUMBERING_UPPER_ROMAN},</li>
- * <li>{@link #LIST_NUMBERING_LOWER_ROMAN},</li>
- * <li>{@link #LIST_NUMBERING_UPPER_ALPHA},</li>
- * <li>{@link #LIST_NUMBERING_LOWER_ALPHA}.</li>
+ * <li>{@link PDListAttributeObject#LIST_NUMBERING_NONE},</li>
+ * <li>{@link PDListAttributeObject#LIST_NUMBERING_DISC},</li>
+ * <li>{@link PDListAttributeObject#LIST_NUMBERING_CIRCLE},</li>
+ * <li>{@link PDListAttributeObject#LIST_NUMBERING_SQUARE},</li>
+ * <li>{@link PDListAttributeObject#LIST_NUMBERING_DECIMAL},</li>
+ * <li>{@link PDListAttributeObject#LIST_NUMBERING_UPPER_ROMAN},</li>
+ * <li>{@link PDListAttributeObject#LIST_NUMBERING_LOWER_ROMAN},</li>
+ * <li>{@link PDListAttributeObject#LIST_NUMBERING_UPPER_ALPHA},</li>
+ * <li>{@link PDListAttributeObject#LIST_NUMBERING_LOWER_ALPHA}.</li>
* </ul>
*
* @param listNumbering the list numbering
@@ -199,9 +199,9 @@ public class PDExportFormatAttributeObje
* contains it, or both the row and the column that contain it. The value
* shall be one of the following:
* <ul>
- * <li>{@link #SCOPE_ROW},</li>
- * <li>{@link #SCOPE_COLUMN}, or</li>
- * <li>{@link #SCOPE_BOTH}.</li>
+ * <li>{@link PDTableAttributeObject#SCOPE_ROW},</li>
+ * <li>{@link PDTableAttributeObject#SCOPE_COLUMN}, or</li>
+ * <li>{@link PDTableAttributeObject#SCOPE_BOTH}.</li>
* </ul>
*
* @param scope the scope
Modified: pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/documentinterchange/taggedpdf/PDLayoutAttributeObject.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/documentinterchange/taggedpdf/PDLayoutAttributeObject.java?rev=1589086&r1=1589085&r2=1589086&view=diff
==============================================================================
--- pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/documentinterchange/taggedpdf/PDLayoutAttributeObject.java (original)
+++ pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/documentinterchange/taggedpdf/PDLayoutAttributeObject.java Tue Apr 22 11:13:40 2014
@@ -1011,7 +1011,7 @@ public class PDLayoutAttributeObject ext
* Gets the style of the border drawn on each edge of a table cell
* (TBorderStyle).
*
- * @return
+ * @return the border style.
*/
public Object getTBorderStyle()
{
Modified: pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/encryption/PublicKeySecurityHandler.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/encryption/PublicKeySecurityHandler.java?rev=1589086&r1=1589085&r2=1589086&view=diff
==============================================================================
--- pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/encryption/PublicKeySecurityHandler.java (original)
+++ pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/encryption/PublicKeySecurityHandler.java Tue Apr 22 11:13:40 2014
@@ -65,7 +65,7 @@ import org.apache.pdfbox.pdmodel.PDDocum
* This class implements the public key security handler
* described in the PDF specification.
*
- * @see PDF Spec 1.6 p104
+ * [PDF 1.6: p 104]
*
* @see PublicKeyProtectionPolicy to see how to protect document with this security handler.
*
@@ -131,7 +131,7 @@ public class PublicKeySecurityHandler ex
* called from there. Only if decryption of single objects is needed this should be called instead.
*
* @param encDictionary encryption dictionary, can be retrieved via {@link PDDocument#getEncryptionDictionary()}
- * @param documentIDArray document id which is returned via {@link COSDocument#getDocumentID()} (not used by this handler)
+ * @param documentIDArray document id which is returned via {@link org.apache.pdfbox.cos.COSDocument#getDocumentID()} (not used by this handler)
* @param decryptionMaterial Information used to decrypt the document.
*
* @throws IOException If there is an error accessing data.
Modified: pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/encryption/SecurityHandler.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/encryption/SecurityHandler.java?rev=1589086&r1=1589085&r2=1589086&view=diff
==============================================================================
--- pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/encryption/SecurityHandler.java (original)
+++ pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/encryption/SecurityHandler.java Tue Apr 22 11:13:40 2014
@@ -501,7 +501,6 @@ public abstract class SecurityHandler
/**
* Getter of the property <tt>keyLength</tt>.
* @return Returns the keyLength.
- * @uml.property name="keyLength"
*/
public int getKeyLength()
{
@@ -542,7 +541,7 @@ public abstract class SecurityHandler
/**
* Set to true if AES for encryption and decryption should be used.
*
- * @param aes if true AES will be used
+ * @param aesValue if true AES will be used
*
*/
public void setAES(boolean aesValue)
Modified: pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/PDFontDescriptor.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/PDFontDescriptor.java?rev=1589086&r1=1589085&r2=1589086&view=diff
==============================================================================
--- pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/PDFontDescriptor.java (original)
+++ pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/PDFontDescriptor.java Tue Apr 22 11:13:40 2014
@@ -524,7 +524,7 @@ public abstract class PDFontDescriptor
/**
* This will set the missing width for the font.
*
- * @param charSet The new missing width for the font.
+ * @param missingWidth The new missing width for the font.
*/
public abstract void setMissingWidth( float missingWidth );
Modified: pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/pattern/PDPatternResources.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/pattern/PDPatternResources.java?rev=1589086&r1=1589085&r2=1589086&view=diff
==============================================================================
--- pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/pattern/PDPatternResources.java (original)
+++ pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/pattern/PDPatternResources.java Tue Apr 22 11:13:40 2014
@@ -185,7 +185,7 @@ public abstract class PDPatternResources
/**
* This will return the paint of the pattern.
*
- * @param the height of the current page
+ * @param pageHeight the height of the current page
*
* @return the paint of the pattern
*/
Modified: pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/shading/AxialShadingPaint.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/shading/AxialShadingPaint.java?rev=1589086&r1=1589085&r2=1589086&view=diff
==============================================================================
--- pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/shading/AxialShadingPaint.java (original)
+++ pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/shading/AxialShadingPaint.java Tue Apr 22 11:13:40 2014
@@ -45,7 +45,7 @@ public class AxialShadingPaint implement
*
* @param shadingType2 the shading resources
* @param ctm current transformation matrix
- * @param pageSizeValue size of the current page
+ * @param pageHeightValue size of the current page
*/
public AxialShadingPaint(PDShadingType2 shadingType2, Matrix ctm, int pageHeightValue)
{
Modified: pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/shading/PDShadingType1.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/shading/PDShadingType1.java?rev=1589086&r1=1589085&r2=1589086&view=diff
==============================================================================
--- pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/shading/PDShadingType1.java (original)
+++ pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/shading/PDShadingType1.java Tue Apr 22 11:13:40 2014
@@ -115,4 +115,88 @@ public class PDShadingType1 extends PDSh
domain = newDomain;
getCOSDictionary().setItem(COSName.DOMAIN, newDomain);
}
+
+ /**
+ * This will set the function for the color conversion.
+ *
+ * @param newFunction The new function.
+ */
+ public void setFunction(PDFunction newFunction)
+ {
+ function = newFunction;
+ getCOSDictionary().setItem(COSName.FUNCTION, newFunction);
+ }
+
+ /**
+ * This will return the function used to convert the color values.
+ *
+ * @return The function
+ * @exception IOException If we are unable to create the PDFunction object.
+ */
+ public PDFunction getFunction() throws IOException
+ {
+ if (function == null)
+ {
+ function = PDFunction.create(getCOSDictionary().getDictionaryObject(COSName.FUNCTION));
+ }
+ return function;
+ }
+
+ /**
+ * Provide the function(s) of the shading dictionary as array.
+ *
+ * @return an array containing the function(s)
+ * @throws IOException throw if something went wrong
+ */
+ private PDFunction[] getFunctionsArray() throws IOException
+ {
+ if (functionArray == null)
+ {
+ COSBase functionObject = getCOSDictionary().getDictionaryObject(COSName.FUNCTION);
+ if (functionObject instanceof COSDictionary)
+ {
+ functionArray = new PDFunction[1];
+ functionArray[0] = PDFunction.create(functionObject);
+ }
+ else
+ {
+ COSArray functionCOSArray = (COSArray)functionObject;
+ int numberOfFunctions = functionCOSArray.size();
+ functionArray = new PDFunction[numberOfFunctions];
+ for (int i=0; i<numberOfFunctions; i++)
+ {
+ functionArray[i] = PDFunction.create(functionCOSArray.get(i));
+ }
+ }
+ }
+ return functionArray;
+ }
+
+ /**
+ * Convert the input value using the functions of the shading dictionary.
+ *
+ * @param input the input values
+ * @return the output values
+ * @throws IOException thrown if something went wrong
+ */
+ public float[] evalFunction(float [] input) throws IOException
+ {
+ PDFunction[] functions = getFunctionsArray();
+ int numberOfFunctions = functions.length;
+ float[] returnValues = null;
+ if (numberOfFunctions == 1)
+ {
+ returnValues = functions[0].eval(input);
+ }
+ else
+ {
+ returnValues = new float[numberOfFunctions];
+ for (int i=0; i<numberOfFunctions;i++)
+ {
+ float[] newValue = functions[i].eval(input);
+ returnValues[i] = newValue[0];
+ }
+ }
+ return returnValues;
+ }
}
Modified: pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/shading/RadialShadingPaint.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/shading/RadialShadingPaint.java?rev=1589086&r1=1589085&r2=1589086&view=diff
==============================================================================
--- pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/shading/RadialShadingPaint.java (original)
+++ pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/shading/RadialShadingPaint.java Tue Apr 22 11:13:40 2014
@@ -45,7 +45,7 @@ public class RadialShadingPaint implemen
*
* @param shadingType3 the shading resources
* @param ctm current transformation matrix
- * @param pageSizeValue size of the current page
+ * @param pageHeightValue size of the current page
*/
public RadialShadingPaint(PDShadingType3 shadingType3, Matrix ctm, int pageHeightValue)
{
Modified: pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/xobject/PDXObject.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/xobject/PDXObject.java?rev=1589086&r1=1589085&r2=1589086&view=diff
==============================================================================
--- pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/xobject/PDXObject.java (original)
+++ pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/xobject/PDXObject.java Tue Apr 22 11:13:40 2014
@@ -126,7 +126,7 @@ public abstract class PDXObject implemen
* Create the correct xobject from the cos base.
*
* @param xobject The cos level xobject to create.
- * @param isthumb specify if the xobject represent a Thumbnail Image (in this case, the subtype null must be
+ * @param isThumb specify if the xobject represent a Thumbnail Image (in this case, the subtype null must be
* considered as an Image)
* @return a pdmodel xobject
* @throws IOException If there is an error creating the xobject.
Modified: pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/SignatureOptions.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/SignatureOptions.java?rev=1589086&r1=1589085&r2=1589086&view=diff
==============================================================================
--- pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/SignatureOptions.java (original)
+++ pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/SignatureOptions.java Tue Apr 22 11:13:40 2014
@@ -70,7 +70,7 @@ public class SignatureOptions
/**
* Reads the visual signature from the given visual signature properties
*
- * @param is the <code>PDVisibleSigProperties</code> object containing the visual signature
+ * @param visSignatureProperties the <code>PDVisibleSigProperties</code> object containing the visual signature
*
* @throws IOException when something went wrong during parsing
*
Modified: pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/visible/PDFTemplateStructure.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/visible/PDFTemplateStructure.java?rev=1589086&r1=1589085&r2=1589086&view=diff
==============================================================================
--- pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/visible/PDFTemplateStructure.java (original)
+++ pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/visible/PDFTemplateStructure.java Tue Apr 22 11:13:40 2014
@@ -79,7 +79,7 @@ public class PDFTemplateStructure
/**
* Returns document page.
- * @return
+ * @return the document page.
*/
public PDPage getPage()
{
@@ -99,7 +99,7 @@ public class PDFTemplateStructure
* Gets PDDocument template.
* This represents a digital signature
* that can be attached to a document
- * @return
+ * @return the template to be used.
*/
public PDDocument getTemplate()
{
@@ -119,7 +119,7 @@ public class PDFTemplateStructure
/**
* Gets Acroform
- * @return
+ * @return the documents AcroForm.
*/
public PDAcroForm getAcroForm()
{
@@ -137,7 +137,7 @@ public class PDFTemplateStructure
/**
* Gets Signature field
- * @return
+ * @return the signature filed to be used.
*/
public PDSignatureField getSignatureField()
{
@@ -155,7 +155,7 @@ public class PDFTemplateStructure
/**
* Gets PDSignature
- * @return
+ * @return the signature object.
*/
public PDSignature getPdSignature()
{
@@ -174,7 +174,7 @@ public class PDFTemplateStructure
/**
* Gets Dictionary of AcroForm. Thats <b> /DR </b>
* entry in the AcroForm
- * @return
+ * @return the AcroForms dictionary object.
*/
public COSDictionary getAcroFormDictionary()
{
@@ -194,7 +194,7 @@ public class PDFTemplateStructure
/**
* Gets SignatureRectangle
- * @return
+ * @return the signatures rectangle.
*/
public PDRectangle getSingatureRectangle()
{
@@ -212,7 +212,7 @@ public class PDFTemplateStructure
/**
* Gets AffineTransform
- * @return
+ * @return the affine transform.
*/
public AffineTransform getAffineTransform()
{
@@ -230,7 +230,7 @@ public class PDFTemplateStructure
/**
* Gets ProcSet Array
- * @return
+ * @return the proc set array.
*/
public COSArray getProcSet()
{
@@ -248,7 +248,7 @@ public class PDFTemplateStructure
/**
* Gets the image of visible signature
- * @return
+ * @return the image used for a visioble signature.
*/
public PDJpeg getJpedImage()
{
@@ -266,7 +266,7 @@ public class PDFTemplateStructure
/**
* Gets formatter rectangle
- * @return
+ * @return the rectangle used by the formatter.
*/
public PDRectangle getFormaterRectangle()
{
@@ -284,7 +284,7 @@ public class PDFTemplateStructure
/**
* Sets HolderFormStream
- * @return
+ * @return the form stream of the holder.
*/
public PDStream getHolderFormStream()
{
@@ -305,7 +305,7 @@ public class PDFTemplateStructure
* That form is here <b> AcroForm/DR/XObject/{holder form name} </b>
* By default, name stars with FRM. We also add number of form
* to the name.
- * @return
+ * @return the holder form.
*/
public PDXObjectForm getHolderForm()
{
@@ -323,7 +323,7 @@ public class PDFTemplateStructure
/**
* Gets Holder form resources
- * @return
+ * @return the holder forms ressources.
*/
public PDResources getHolderFormResources()
{
@@ -342,7 +342,7 @@ public class PDFTemplateStructure
/**
* Gets AppearanceDictionary
* That is <b>/AP</b> entry the appearance dictionary.
- * @return
+ * @return the appearance dictionary.
*/
public PDAppearanceDictionary getAppearanceDictionary()
{
@@ -361,7 +361,7 @@ public class PDFTemplateStructure
/**
* Gets Inner form Stream.
- * @return
+ * @return the inner form's stream.
*/
public PDStream getInnterFormStream()
{
@@ -379,7 +379,7 @@ public class PDFTemplateStructure
/**
* Gets inner form Resource
- * @return
+ * @return the inner form's resources.
*/
public PDResources getInnerFormResources()
{
@@ -400,7 +400,7 @@ public class PDFTemplateStructure
* <b> AcroForm/DR/XObject/{holder form name}/Resources/XObject/{inner name} </b>
* By default inner form name starts with "n". Then we add number of form
* to the name.
- * @return
+ * @return the inner form.
*/
public PDXObjectForm getInnerForm()
{
@@ -419,7 +419,7 @@ public class PDFTemplateStructure
/**
* Gets name of inner form
- * @return
+ * @return the inner form's name.
*/
public String getInnerFormName()
{
@@ -437,7 +437,7 @@ public class PDFTemplateStructure
/**
* Gets Image form stream
- * @return
+ * @return the image form's stream.
*/
public PDStream getImageFormStream()
{
@@ -455,7 +455,7 @@ public class PDFTemplateStructure
/**
* Gets image form resources
- * @return
+ * @return the image form's resources.
*/
public PDResources getImageFormResources()
{
@@ -475,7 +475,7 @@ public class PDFTemplateStructure
* Gets Image form. Image form is in this structure:
* <b>/AcroForm/DR/{holder form}/Resources/XObject /{inner form} </b>
* /Resources/XObject/{image form name}.
- * @return
+ * @return the image form.
*/
public PDXObjectForm getImageForm()
{
@@ -498,7 +498,7 @@ public class PDFTemplateStructure
/**
* Gets image form name
- * @return
+ * @return the image form's name.
*/
public String getImageFormName()
{
@@ -516,7 +516,7 @@ public class PDFTemplateStructure
/**
* Gets visible signature image name
- * @return
+ * @return the visible signature image's name
*/
public String getImageName()
{
@@ -535,7 +535,7 @@ public class PDFTemplateStructure
/**
* Gets COSDocument of visible Signature.
* @see org.apache.pdfbox.cos.COSDocument
- * @return
+ * @return the document representing the visual signature.
*/
public COSDocument getVisualSignature()
{
@@ -555,7 +555,7 @@ public class PDFTemplateStructure
/**
* Gets acroFormFields
- * @return
+ * @return the fields within the AcroForm.
*/
public List<PDField> getAcroFormFields()
{
@@ -573,7 +573,7 @@ public class PDFTemplateStructure
/**
* Gets AP of the created template
- * @return
+ * @return the appearance stream of the created template.
* @throws IOException
* @throws COSVisitorException
*/
@@ -594,8 +594,8 @@ public class PDFTemplateStructure
/**
* Gets Widget Dictionary.
* {@link org.apache.pdfbox.pdmodel.interactive.form.PDField}
- * @see org.apache.pdfbox.pdmodel.interactive.form.PDField.getWidget()
- * @return
+ * @see org.apache.pdfbox.pdmodel.interactive.form.PDField#getWidget()
+ * @return the dictionary representing the widget.
*/
public COSDictionary getWidgetDictionary()
{
@@ -605,7 +605,7 @@ public class PDFTemplateStructure
/**
* Sets Widget Dictionary.
* {@link org.apache.pdfbox.pdmodel.interactive.form.PDField}
- * @see org.apache.pdfbox.pdmodel.interactive.form.PDField.getWidget()
+ * @see org.apache.pdfbox.pdmodel.interactive.form.PDField#getWidget()
* @param widgetDictionary
*/
public void setWidgetDictionary(COSDictionary widgetDictionary)
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=1589086&r1=1589085&r2=1589086&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 Tue Apr 22 11:13:40 2014
@@ -61,7 +61,7 @@ public class PDVisibleSigProperties
/**
* Sets signer name
* @param signerName
- * @return
+ * @return the visible signature properties.
*/
public PDVisibleSigProperties signerName(String signerName)
{
@@ -81,7 +81,7 @@ public class PDVisibleSigProperties
/**
* Sets location
* @param signerLocation
- * @return
+ * @return the visible signature properties.
*/
public PDVisibleSigProperties signerLocation(String signerLocation)
{
@@ -91,7 +91,7 @@ public class PDVisibleSigProperties
/**
* gets reason of signing
- * @return
+ * @return the signing reason.
*/
public String getSignatureReason()
{
@@ -101,7 +101,7 @@ public class PDVisibleSigProperties
/**
* sets reason of signing
* @param signatureReason
- * @return
+ * @return the visible signature properties.
*/
public PDVisibleSigProperties signatureReason(String signatureReason)
{
@@ -111,7 +111,7 @@ public class PDVisibleSigProperties
/**
* returns your page
- * @return
+ * @return the page number.
*/
public int getPage()
{
@@ -121,7 +121,7 @@ public class PDVisibleSigProperties
/**
* sets page number
* @param page
- * @return
+ * @return the visible signature properties.
*/
public PDVisibleSigProperties page(int page)
{
@@ -131,7 +131,7 @@ public class PDVisibleSigProperties
/**
* gets our preferred size
- * @return
+ * @return the signature's preferred size.
*/
public int getPreferredSize()
{
@@ -141,7 +141,7 @@ public class PDVisibleSigProperties
/**
* sets our preferred size
* @param preferredSize
- * @return
+ * @return the visible signature properties.
*/
public PDVisibleSigProperties preferredSize(int preferredSize)
{
@@ -151,7 +151,7 @@ public class PDVisibleSigProperties
/**
* checks if we need to add visible signature
- * @return
+ * @return state if visible signature is needed.
*/
public boolean isVisualSignEnabled()
{
@@ -161,7 +161,7 @@ public class PDVisibleSigProperties
/**
* sets visible signature to be added or not
* @param visualSignEnabled
- * @return
+ * @return the visible signature properties.
*/
public PDVisibleSigProperties visualSignEnabled(boolean visualSignEnabled)
{
@@ -171,7 +171,7 @@ public class PDVisibleSigProperties
/**
* this method gets visible signature configuration object
- * @return
+ * @return the visible signature configuration.
*/
public PDVisibleSignDesigner getPdVisibleSignature()
{
@@ -181,7 +181,7 @@ public class PDVisibleSigProperties
/**
* Sets visible signature configuration Object
* @param pdVisibleSignature
- * @return
+ * @return the visible signature properties.
*/
public PDVisibleSigProperties setPdVisibleSignature(PDVisibleSignDesigner pdVisibleSignature)
{
@@ -191,7 +191,7 @@ public class PDVisibleSigProperties
/**
* returns visible signature configuration object
- * @return
+ * @return the input stream representing the visible signature.
*/
public InputStream getVisibleSignature()
{
Modified: pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/visible/PDVisibleSignDesigner.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/visible/PDVisibleSignDesigner.java?rev=1589086&r1=1589085&r2=1589086&view=diff
==============================================================================
--- pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/visible/PDVisibleSignDesigner.java (original)
+++ pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/visible/PDVisibleSignDesigner.java Tue Apr 22 11:13:40 2014
@@ -61,7 +61,7 @@ public class PDVisibleSignDesigner
*
* @param originalDocumenStream
* @param imageStream
- * @param page-which page are you going to add visible signature
+ * @param page the page the visible signature is added to.
* @throws IOException
*/
public PDVisibleSignDesigner(InputStream originalDocumenStream, InputStream imageStream, int page) throws IOException
@@ -75,7 +75,7 @@ public class PDVisibleSignDesigner
*
* @param documentPath - path of your pdf document
* @param imageStream - stream of image
- * @param page -which page are you going to add visible signature
+ * @param page the page the visible signature is added to.
* @throws IOException
*/
public PDVisibleSignDesigner(String documentPath, InputStream imageStream, int page) throws IOException
@@ -149,7 +149,7 @@ public class PDVisibleSignDesigner
/**
* zoom signature image with some percent.
*
- * @param percent- x % increase image with x percent.
+ * @param percent the percentage for zooming the image.
* @return Visible Signature Configuration Object
*/
public PDVisibleSignDesigner zoom(float percent)
@@ -161,9 +161,9 @@ public class PDVisibleSignDesigner
/**
*
- * @param xAxis - x coordinate
- * @param yAxis - y coordinate
- * @return Visible Signature Configuration Object
+ * @param x the x coordinate.
+ * @param y the y coordinate.
+ * @return Visible Signature Configuration Object.
*/
public PDVisibleSignDesigner coordinates(float x, float y)
{
@@ -223,8 +223,8 @@ public class PDVisibleSignDesigner
/**
*
- * @param sets signature image width
- * @return Visible Signature Configuration Object
+ * @param signatureImgWidth the signature image width.
+ * @return Visible Signature Configuration Object.
*/
public PDVisibleSignDesigner width(float signatureImgWidth)
{
@@ -243,7 +243,7 @@ public class PDVisibleSignDesigner
/**
*
- * @param set signature image Height
+ * @param signatureImgHeight the signature image height
* @return Visible Signature Configuration Object
*/
public PDVisibleSignDesigner height(float signatureImgHeight)
@@ -406,8 +406,8 @@ public class PDVisibleSignDesigner
/**
*
- * @param sets pageWidth
- * @return Visible Signature Configuration Object
+ * @param pageWidth the pageWidth.
+ * @return Visible Signature Configuration Object.
*/
public PDVisibleSignDesigner pageWidth(float pageWidth)
{
@@ -426,7 +426,7 @@ public class PDVisibleSignDesigner
/**
* get image size in percents
- * @return
+ * @return image size in percents.
*/
public float getImageSizeInPercents()
{
@@ -444,7 +444,7 @@ public class PDVisibleSignDesigner
/**
* returns visible signature text
- * @return
+ * @return visible signature text.
*/
public String getSignatureText()
{
@@ -454,7 +454,7 @@ public class PDVisibleSignDesigner
/**
*
* @param signatureText - adds the text on visible signature
- * @return
+ * @return the signature design representing the text.
*/
public PDVisibleSignDesigner signatureText(String signatureText)
{
Modified: pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/documentnavigation/destination/PDPageDestination.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/documentnavigation/destination/PDPageDestination.java?rev=1589086&r1=1589085&r2=1589086&view=diff
==============================================================================
--- pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/documentnavigation/destination/PDPageDestination.java (original)
+++ pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/documentnavigation/destination/PDPageDestination.java Tue Apr 22 11:13:40 2014
@@ -118,7 +118,7 @@ public abstract class PDPageDestination
* this is a page number or a reference to a page.
*
* @since Apache PDFBox 1.0.0
- * @see PDOutlineItem
+ * @see org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
* @return page number, or -1 if the destination type is unknown
*/
public int findPageNumber() {
Modified: pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDPushButton.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDPushButton.java?rev=1589086&r1=1589085&r2=1589086&view=diff
==============================================================================
--- pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDPushButton.java (original)
+++ pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDPushButton.java Tue Apr 22 11:13:40 2014
@@ -32,7 +32,7 @@ public class PDPushButton extends PDFiel
{
/**
- * @see org.apache.pdfbox.pdmodel.field.PDField#COSField(org.apache.pdfbox.cos.COSDictionary)
+ * @see PDField#PDField(PDAcroForm, COSDictionary)
*
* @param theAcroForm The acroForm for this field.
* @param field The field for this push button.
@@ -43,7 +43,7 @@ public class PDPushButton extends PDFiel
}
/**
- * @see as.interactive.pdf.form.cos.COSField#setValue(java.lang.String)
+ * @see PDField#setValue(java.lang.String)
*
* @param value The new value for the field.
*
Modified: pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/util/BitFlagHelper.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/util/BitFlagHelper.java?rev=1589086&r1=1589085&r2=1589086&view=diff
==============================================================================
--- pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/util/BitFlagHelper.java (original)
+++ pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/util/BitFlagHelper.java Tue Apr 22 11:13:40 2014
@@ -79,7 +79,7 @@ public class BitFlagHelper
*
* @return true if the number at bitPos is '1'
*
- * @deprecated use {@link #getFlag(COSDictionary, COSName, boolean)} using COSName constants instead
+ * @deprecated use {@link #getFlag(COSDictionary, COSName, int)} using COSName constants instead
*/
public static final boolean getFlag(COSDictionary dic, String field, int bitFlag)
{
Modified: pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/util/DateConverter.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/util/DateConverter.java?rev=1589086&r1=1589085&r2=1589086&view=diff
==============================================================================
--- pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/util/DateConverter.java (original)
+++ pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/util/DateConverter.java Tue Apr 22 11:13:40 2014
@@ -578,7 +578,7 @@ public class DateConverter
* @param text The text to be parsed.
*
* @param fmts A list of formats to be tried. The syntax is that for
- * {@link #java.text.SimpleDateFormat}
+ * {@link java.text.SimpleDateFormat}
*
* @param initialWhere At start this is the position to begin
* examining the text. Upon return it will have been
@@ -732,7 +732,7 @@ public class DateConverter
/**
* Converts a string to a Calendar by parsing the String for a date.
- * @see toCalendar(String).
+ * @see #toCalendar(String).
*
* The returned value will have 0 for DST_OFFSET.
*
@@ -741,7 +741,7 @@ public class DateConverter
* Or null if text was null.
* @throws IOException If the date string is not in the correct format.
* @deprecated This method throws an IOException for failure. Replace
- * calls to it with {@link #toCalendar(text.getString(), null)}
+ * calls to it with {@link #toCalendar(String, String[])}
* and test for failure with
* (value == null || value.get(Calendar.YEAR) == INVALID_YEAR)
*/
@@ -756,7 +756,7 @@ public class DateConverter
/**
* Converts a string date to a Calendar date value; equivalent to
- * {@link #toCalendar(String, null)},
+ * {@link #toCalendar(String, String[])} using <pre>null</pre> for the second parameter,
* but throws an IOException for failure.
*
* The returned value will have 0 for DST_OFFSET.
@@ -767,7 +767,8 @@ public class DateConverter
* @throws IOException If the date string is non-null
* and not a parseable date.
* @deprecated This method throws an IOException for failure. Replace
- * calls to it with {@link #toCalendar(text, null)}
+ * calls to it with {@link #toCalendar(String, String[])}
+ * using <pre>null</pre> for the second parameter
* and test for failure with
* (value == null || value.get(Calendar.YEAR) == INVALID_YEAR)
*/
Modified: pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/util/ICU4JImpl.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/util/ICU4JImpl.java?rev=1589086&r1=1589085&r2=1589086&view=diff
==============================================================================
--- pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/util/ICU4JImpl.java (original)
+++ pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/util/ICU4JImpl.java Tue Apr 22 11:13:40 2014
@@ -49,7 +49,7 @@ public class ICU4JImpl
/**
* Takes a line of text in presentation order and converts it to logical order.
- * @see TextNormalize.makeLineLogicalOrder(String, boolean)
+ * @see TextNormalize#makeLineLogicalOrder(String, boolean)
*
* @param str String to convert
* @param isRtlDominant RTL (right-to-left) will be the dominant text direction
@@ -69,7 +69,7 @@ public class ICU4JImpl
/**
* Normalize presentation forms of characters to the separate parts.
- * @see TextNormalize.normalizePres(String)
+ * @see TextNormalize#normalizePres(String)
*
* @param str String to normalize
* @return Normalized form
Modified: pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/util/PDFImageWriter.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/util/PDFImageWriter.java?rev=1589086&r1=1589085&r2=1589086&view=diff
==============================================================================
--- pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/util/PDFImageWriter.java (original)
+++ pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/util/PDFImageWriter.java Tue Apr 22 11:13:40 2014
@@ -66,7 +66,7 @@ public class PDFImageWriter extends PDFS
/**
* Converts a given page range of a PDF document to bitmap images by calling
- * {@link writeImage(PDDocument document, String imageFormat, String password, int startPage, int endPage,
+ * {@link #writeImage(PDDocument document, String imageFormat, String password, int startPage, int endPage,
* String outputPrefix, int imageType, int resolution)} with imageType {@link BufferedImage}.TYPE_INT_RGB
* and screen resolution, or 96dpi if screen resolution is unavailable.
*
Modified: pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/util/PageExtractor.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/util/PageExtractor.java?rev=1589086&r1=1589085&r2=1589086&view=diff
==============================================================================
--- pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/util/PageExtractor.java (original)
+++ pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/util/PageExtractor.java Tue Apr 22 11:13:40 2014
@@ -33,7 +33,7 @@ public class PageExtractor {
/**
* Creates a new instance of PageExtractor
- * @param document The document to split.
+ * @param sourceDocument The document to split.
*/
public PageExtractor(PDDocument sourceDocument) {
this.sourceDocument = sourceDocument;
@@ -42,7 +42,7 @@ public class PageExtractor {
/**
* Creates a new instance of PageExtractor
- * @param document The document to split.
+ * @param sourceDocument The document to split.
* @param startPage The first page you want extracted (inclusive)
* @param endPage The last page you want extracted (inclusive)
*/
Modified: pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/util/TextPosition.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/util/TextPosition.java?rev=1589086&r1=1589085&r2=1589086&view=diff
==============================================================================
--- pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/util/TextPosition.java (original)
+++ pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/util/TextPosition.java Tue Apr 22 11:13:40 2014
@@ -133,7 +133,7 @@ public class TextPosition
* @param fontSizeValue The new font size.
* @param fontSizeInPt The font size in pt units.
*
- * @deprecated Use {@link TextPosition(int, float, float, Matrix, float, float, float, float, float,
+ * @deprecated Use {@link #TextPosition(int, float, float, Matrix, float, float, float, float, float,
* String, PDFont, float, int)} instead.
*/
public TextPosition(