svn commit: r1692421 - /pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/visible/PDVisibleSignDesigner.java

[ti...@apache.org]

Author: tilman
Date: Thu Jul 23 16:56:00 2015
New Revision: 1692421

URL: http://svn.apache.org/r1692421
Log:
PDFBOX-2852: improve javadoc

Modified:
    pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/visible/PDVisibleSignDesigner.java

Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/visible/PDVisibleSignDesigner.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/visible/PDVisibleSignDesigner.java?rev=1692421&r1=1692420&r2=1692421&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/visible/PDVisibleSignDesigner.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/visible/PDVisibleSignDesigner.java Thu Jul 23 16:56:00 2015
@@ -52,7 +52,7 @@ public class PDVisibleSignDesigner
      *
      * @param filename Path of the PDF file
      * @param jpegStream JPEG image as a stream
-     * @param page The page are you going to add visible signature
+     * @param page The 1-based page number for which the page size should be calculated.
      * @throws IOException
      */
     public PDVisibleSignDesigner(String filename, InputStream jpegStream, int page)
@@ -66,7 +66,7 @@ public class PDVisibleSignDesigner
      *
      * @param documentStream Original PDF document as stream
      * @param jpegStream JPEG image as a stream
-     * @param page The page are you going to add visible signature
+     * @param page The 1-based page number for which the page size should be calculated.
      * @throws IOException
      */
     public PDVisibleSignDesigner(InputStream documentStream, InputStream jpegStream, int page)
@@ -78,7 +78,7 @@ public class PDVisibleSignDesigner
         // create PD document
         PDDocument document = PDDocument.load(documentStream);
 
-        // calculate height an width of document
+        // calculate height and width of document page
         calculatePageSize(document, page);
 
         document.close();
@@ -89,7 +89,7 @@ public class PDVisibleSignDesigner
      *
      * @param doc - Already created PDDocument of your PDF document
      * @param jpegStream
-     * @param page
+     * @param page The 1-based page number for which the page size should be calculated.
      * @throws IOException - If we can't read, flush, or can't close stream
      */
     public PDVisibleSignDesigner(PDDocument doc, InputStream jpegStream, int page) throws IOException
@@ -99,10 +99,11 @@ public class PDVisibleSignDesigner
     }
 
     /**
-     * Each page of document can be different sizes.
+     * Each page of document can be different sizes. This method calculates the page size based on
+     * the page media box.
      * 
      * @param document
-     * @param page
+     * @param page The 1-based page number for which the page size should be calculated.
      */
     private void calculatePageSize(PDDocument document, int page)
     {