svn commit: r1753571 - /pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/visible/PDFTemplateBuilder.java

[ti...@apache.org]

Author: tilman
Date: Wed Jul 20 17:08:47 2016
New Revision: 1753571

URL: http://svn.apache.org/viewvc?rev=1753571&view=rev
Log:
PDFBOX-3017: improve javadoc, rename parameter names

Modified:
    pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/visible/PDFTemplateBuilder.java

Modified: pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/visible/PDFTemplateBuilder.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/visible/PDFTemplateBuilder.java?rev=1753571&r1=1753570&r2=1753571&view=diff
==============================================================================
--- pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/visible/PDFTemplateBuilder.java (original)
+++ pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/visible/PDFTemplateBuilder.java Wed Jul 20 17:08:47 2016
@@ -75,14 +75,17 @@ public interface PDFTemplateBuilder
     void createSignatureField(PDAcroForm acroForm) throws IOException;
 
     /**
-     * Creates PDSignatureField.
-     * 
+     * Creates the signature with the given name and assign it to the signature field parameter and
+     * assign the page parameter to the widget.
+     *
      * @param pdSignatureField
      * @param page
-     * @param signatureName
+     * @param signerName the name of the person or authority signing the document. According to the
+     * PDF specification, this value should be used only when it is not possible to extract the name
+     * from the signature.
      * @throws IOException
      */
-    void createSignature(PDSignatureField pdSignatureField, PDPage page, String signatureName)
+    void createSignature(PDSignatureField pdSignatureField, PDPage page, String signerName)
             throws IOException;
 
     /**
@@ -227,7 +230,7 @@ public interface PDFTemplateBuilder
      * injects appearance streams
      * 
      * @param holderFormStream
-     * @param innterFormStream
+     * @param innerFormStream
      * @param imageFormStream
      * @param imageObjectName
      * @param imageName