You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pdfbox.apache.org by le...@apache.org on 2018/03/19 19:45:34 UTC
svn commit: r1827237 - in
/pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel: ./
common/function/ interactive/digitalsignature/ interactive/pagenavigation/
Author: lehmi
Date: Mon Mar 19 19:45:34 2018
New Revision: 1827237
URL: http://svn.apache.org/viewvc?rev=1827237&view=rev
Log:
PDFBOX-4071: fix javadoc
Modified:
pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PageMode.java
pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/ResourceCache.java
pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/function/PDFunction.java
pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/PDSeedValueCertificate.java
pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/SignatureInterface.java
pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/pagenavigation/PDTransition.java
Modified: pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PageMode.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PageMode.java?rev=1827237&r1=1827236&r2=1827237&view=diff
==============================================================================
--- pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PageMode.java (original)
+++ pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PageMode.java Mon Mar 19 19:45:34 2018
@@ -81,7 +81,7 @@ public enum PageMode
/**
* Returns the string value, as used in a PDF file.
*
- * @param the string value.
+ * @return the string value.
*/
public String stringValue()
{
Modified: pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/ResourceCache.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/ResourceCache.java?rev=1827237&r1=1827236&r2=1827237&view=diff
==============================================================================
--- pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/ResourceCache.java (original)
+++ pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/ResourceCache.java Mon Mar 19 19:45:34 2018
@@ -40,6 +40,7 @@ public interface ResourceCache
* @param indirect the indirect object
*
* @return the font resource of the given indirect object.
+ * @throws IOException if something went wrong.
*/
PDFont getFont(COSObject indirect) throws IOException;
@@ -49,6 +50,7 @@ public interface ResourceCache
* @param indirect the indirect object
*
* @return the color space resource of the given indirect object.
+ * @throws IOException if something went wrong.
*/
PDColorSpace getColorSpace(COSObject indirect) throws IOException;
@@ -58,6 +60,7 @@ public interface ResourceCache
* @param indirect the indirect object
*
* @return the extended graphics resource of the given indirect object.
+ * @throws IOException if something went wrong.
*/
PDExtendedGraphicsState getExtGState(COSObject indirect);
@@ -67,6 +70,7 @@ public interface ResourceCache
* @param indirect the indirect object
*
* @return the shading resource of the given indirect object.
+ * @throws IOException if something went wrong.
*/
PDShading getShading(COSObject indirect) throws IOException;
@@ -76,6 +80,7 @@ public interface ResourceCache
* @param indirect the indirect object
*
* @return the pattern resource of the given indirect object.
+ * @throws IOException if something went wrong.
*/
PDAbstractPattern getPattern(COSObject indirect) throws IOException;
@@ -85,6 +90,7 @@ public interface ResourceCache
* @param indirect the indirect object
*
* @return the property list resource of the given indirect object.
+ * @throws IOException if something went wrong.
*/
PDPropertyList getProperties(COSObject indirect);
@@ -94,6 +100,7 @@ public interface ResourceCache
* @param indirect the indirect object
*
* @return the XObject resource of the given indirect object.
+ * @throws IOException if something went wrong.
*/
PDXObject getXObject(COSObject indirect) throws IOException;
@@ -111,7 +118,7 @@ public interface ResourceCache
* Puts the given indirect color space resource in the cache.
*
* @param indirect the indirect object of the resource.
- * @param font the color space resource.
+ * @param colorSpace the color space resource.
*
* @throws IOException if something went wrong.
*/
@@ -121,7 +128,7 @@ public interface ResourceCache
* Puts the given indirect extended graphics state resource in the cache.
*
* @param indirect the indirect object of the resource.
- * @param font the extended graphics state resource.
+ * @param extGState the extended graphics state resource.
*
* @throws IOException if something went wrong.
*/
@@ -131,7 +138,7 @@ public interface ResourceCache
* Puts the given indirect shading resource in the cache.
*
* @param indirect the indirect object of the resource.
- * @param font the shading resource.
+ * @param shading the shading resource.
*
* @throws IOException if something went wrong.
*/
@@ -141,7 +148,7 @@ public interface ResourceCache
* Puts the given indirect pattern resource in the cache.
*
* @param indirect the indirect object of the resource.
- * @param font the pattern resource.
+ * @param pattern the pattern resource.
*
* @throws IOException if something went wrong.
*/
@@ -151,7 +158,7 @@ public interface ResourceCache
* Puts the given indirect property list resource in the cache.
*
* @param indirect the indirect object of the resource.
- * @param font the property list resource.
+ * @param propertyList the property list resource.
*
* @throws IOException if something went wrong.
*/
@@ -161,7 +168,7 @@ public interface ResourceCache
* Puts the given indirect XObject resource in the cache.
*
* @param indirect the indirect object of the resource.
- * @param font the XObject resource.
+ * @param xobject the XObject resource.
*
* @throws IOException if something went wrong.
*/
Modified: pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/function/PDFunction.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/function/PDFunction.java?rev=1827237&r1=1827236&r2=1827237&view=diff
==============================================================================
--- pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/function/PDFunction.java (original)
+++ pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/function/PDFunction.java Mon Mar 19 19:45:34 2018
@@ -238,6 +238,7 @@ public abstract class PDFunction impleme
* @param input The array of input values for the function.
*
* @return The of outputs the function returns based on those inputs.
+ * @throws IOException if something went wrong.
*
* @deprecated Replaced by {@link #eval(float[] input)}
*/
Modified: pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/PDSeedValueCertificate.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/PDSeedValueCertificate.java?rev=1827237&r1=1827236&r2=1827237&view=diff
==============================================================================
--- pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/PDSeedValueCertificate.java (original)
+++ pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/PDSeedValueCertificate.java Mon Mar 19 19:45:34 2018
@@ -545,8 +545,10 @@ public class PDSeedValueCertificate impl
}
/**
- * Returns A list of array of bytes that contain Object Identifiers (OIDs) of the certificate
- * policies that must be present in the signing certificate
+ * Returns A list of array of bytes that contain Object Identifiers (OIDs) of the certificate policies that must be
+ * present in the signing certificate
+ *
+ * @return an array of object identifiers.
*/
public List<byte[]> getOID()
{
@@ -579,7 +581,7 @@ public class PDSeedValueCertificate impl
/**
* works like {@link #setOID(List)} but for one object
*
- * @param oid
+ * @param oid the object identifier.
*/
public void addOID(byte[] oid)
{
@@ -601,7 +603,7 @@ public class PDSeedValueCertificate impl
/**
* removes an OID from the list
*
- * @param oid
+ * @param oid the object identifier to be removed.
*/
public void removeOID(byte[] oid)
{
@@ -615,6 +617,8 @@ public class PDSeedValueCertificate impl
/**
* returns String of the URL
+ *
+ * @return the URL
*/
public String getURL()
{
Modified: pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/SignatureInterface.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/SignatureInterface.java?rev=1827237&r1=1827236&r2=1827237&view=diff
==============================================================================
--- pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/SignatureInterface.java (original)
+++ pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/SignatureInterface.java Mon Mar 19 19:45:34 2018
@@ -31,6 +31,7 @@ public interface SignatureInterface
*
* @param content is the content as a (Filter)InputStream
* @return signature as a byte array
+ * @throws IOException if something went wrong
*/
byte[] sign(InputStream content) throws IOException;
}
Modified: pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/pagenavigation/PDTransition.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/pagenavigation/PDTransition.java?rev=1827237&r1=1827236&r2=1827237&view=diff
==============================================================================
--- pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/pagenavigation/PDTransition.java (original)
+++ pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/pagenavigation/PDTransition.java Mon Mar 19 19:45:34 2018
@@ -136,6 +136,8 @@ public final class PDTransition extends
* Sets the direction in which the specified transition effect shall moves. Only for {@link PDTransitionStyle#Wipe},
* {@link PDTransitionStyle#Glitter}, {@link PDTransitionStyle#Fly}, {@link PDTransitionStyle#Cover},
* {@link PDTransitionStyle#Uncover} and {@link PDTransitionStyle#Push}.
+ *
+ * @param direction the direction in which the specified transition effect shall move.
*/
public void setDirection(PDTransitionDirection direction)
{