pdfbox-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From le...@apache.org
Subject svn commit: r1827236 - in /pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive: action/ digitalsignature/ pagenavigation/
Date Mon, 19 Mar 2018 19:34:28 GMT
Author: lehmi
Date: Mon Mar 19 19:34:28 2018
New Revision: 1827236

URL: http://svn.apache.org/viewvc?rev=1827236&view=rev
Log:
PDFBOX-4071: fix javadoc

Modified:
    pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/action/PDActionEmbeddedGoTo.java
    pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/ExternalSigningSupport.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/pagenavigation/PDTransition.java

Modified: pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/action/PDActionEmbeddedGoTo.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/action/PDActionEmbeddedGoTo.java?rev=1827236&r1=1827235&r2=1827236&view=diff
==============================================================================
--- pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/action/PDActionEmbeddedGoTo.java
(original)
+++ pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/action/PDActionEmbeddedGoTo.java
Mon Mar 19 19:34:28 2018
@@ -182,7 +182,7 @@ public class PDActionEmbeddedGoTo extend
     /**
      * Sets the target directory.
      * 
-     * @param targetDirectory
+     * @param targetDirectory the target directory.
      */
     public void setTargetDirectory(PDTargetDirectory targetDirectory)
     {

Modified: pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/ExternalSigningSupport.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/ExternalSigningSupport.java?rev=1827236&r1=1827235&r2=1827236&view=diff
==============================================================================
--- pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/ExternalSigningSupport.java
(original)
+++ pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/ExternalSigningSupport.java
Mon Mar 19 19:34:28 2018
@@ -31,7 +31,7 @@ public interface ExternalSigningSupport
      *
      * @return content stream
      *
-     * @throws java.io.IOException
+     * @throws java.io.IOException if something went wrong
      */
     InputStream getContent() throws IOException;
 

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=1827236&r1=1827235&r2=1827236&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:34:28 2018
@@ -214,6 +214,8 @@ public class PDSeedValueCertificate impl
 
     /**
      * Returns list of byte arrays that contains DER-encoded X.509v3 certificates
+     * 
+     * @return a list of bytes arrays representing the subject.
      */
     public List<byte[]> getSubject()
     {
@@ -284,9 +286,10 @@ public class PDSeedValueCertificate impl
     }
 
     /**
-     * Returns list of maps that contains subject distinguished names like [(cn: John Doe,
o: Doe),
-     * (cn: John Smith)] both keys are typically of the form 'cn', 'o', 'email', '2.5.4.43';
and
-     * values are text strings.
+     * Returns list of maps that contains subject distinguished names like [(cn: John Doe,
o: Doe), (cn: John Smith)]
+     * both keys are typically of the form 'cn', 'o', 'email', '2.5.4.43'; and values are
text strings.
+     * 
+     * @return a list of maps containing the subject distinguished names
      */
     public List<Map<String, String>> getSubjectDN()
     {
@@ -339,9 +342,9 @@ public class PDSeedValueCertificate impl
     }
 
     /**
-     * Returns list of key usages of certificate strings where each string is 9 characters
long and
-     * each character is one of these values {0, 1, X} 0 for must not set, 1 for must set,
X for
-     * don't care. each index in the string represents a key usage:
+     * Returns list of key usages of certificate strings where each string is 9 characters
long and each character is
+     * one of these values {0, 1, X} 0 for must not set, 1 for must set, X for don't care.
each index in the string
+     * represents a key usage:
      * <ol>
      * <li>digitalSignature</li>
      * <li>non-Repudiation</li>
@@ -353,6 +356,8 @@ public class PDSeedValueCertificate impl
      * <li>encipherOnly</li>
      * <li>decipherOnly</li>
      * </ol>
+     * 
+     * @return list of key usages
      */
     public List<String> getKeyUsage()
     {
@@ -469,6 +474,8 @@ public class PDSeedValueCertificate impl
 
     /**
      * Returns list of array of bytes of DER-encoded X.509v3 certificates
+     * 
+     * @return a list of byte arrays representing the issuer
      */
     public List<byte[]> getIssuer()
     {

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=1827236&r1=1827235&r2=1827236&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:34:28 2018
@@ -44,7 +44,7 @@ public final class PDTransition extends
     /**
      * creates a new transition with the given style.
      * 
-     * @param style
+     * @param style the style to be used.
      */
     public PDTransition(PDTransitionStyle style)
     {
@@ -56,7 +56,7 @@ public final class PDTransition extends
     /**
      * creates a new transition for an existing dictionary
      * 
-     * @param dictionary
+     * @param dictionary the dictionary to be used.
      */
     public PDTransition(COSDictionary dictionary)
     {
@@ -85,6 +85,9 @@ public final class PDTransition extends
     /**
      * Sets the dimension in which the specified transition effect shall occur. Only for
{@link PDTransitionStyle#Split}
      * and {@link PDTransitionStyle#Blinds}.
+     * 
+     * @param dimension the dimension.
+     * 
      */
     public void setDimension(PDTransitionDimension dimension)
     {
@@ -104,6 +107,8 @@ public final class PDTransition extends
     /**
      * Sets the direction of motion for the specified transition effect. Only for {@link
PDTransitionStyle#Split},
      * {@link PDTransitionStyle#Blinds} and {@link PDTransitionStyle#Fly}.
+     * 
+     * @param motion the motion for the specified effect.
      */
     public void setMotion(PDTransitionMotion motion)
     {
@@ -114,6 +119,8 @@ public final class PDTransition extends
      * @return the direction in which the specified transition effect shall moves. It can
be either a {@link COSInteger}
      * or {@link COSName#NONE}. Default to {@link COSInteger#ZERO}
      * @see PDTransitionDirection
+     * 
+     * @return the direction.
      */
     public COSBase getDirection()
     {



Mime
View raw message