pdfbox-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From til...@apache.org
Subject svn commit: r1839026 - /pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/multipdf/Overlay.java
Date Sat, 25 Aug 2018 11:28:18 GMT
Author: tilman
Date: Sat Aug 25 11:28:17 2018
New Revision: 1839026

URL: http://svn.apache.org/viewvc?rev=1839026&view=rev
Log:
PDFBOX-4294: clarify javadoc

Modified:
    pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/multipdf/Overlay.java

Modified: pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/multipdf/Overlay.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/multipdf/Overlay.java?rev=1839026&r1=1839025&r2=1839026&view=diff
==============================================================================
--- pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/multipdf/Overlay.java (original)
+++ pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/multipdf/Overlay.java Sat Aug
25 11:28:17 2018
@@ -87,22 +87,22 @@ public class Overlay
     private String evenPageOverlayFilename = null;
     private PDDocument evenPageOverlay = null;
 
-    
     private int numberOfOverlayPages = 0;
     private boolean useAllOverlayPages = false;
 
     /**
-     * This will add overlays to a documents.
-     * 
-     * @param specificPageOverlayFile map of overlay files for specific pages,
-     * The page numbers are 1-based.
+     * This will add overlays to a document.
+     *
+     * @param specificPageOverlayFile map of overlay files for specific pages. The page numbers
are
+     * 1-based.
+     *
+     * @return The modified input PDF document, which has to be saved and closed by the caller.
If
+     * the input document was passed by {@link #setInputPDF(PDDocument) setInputPDF(PDDocument)}
+     * then it is that object that is returned.
      *
-     * @return the resulting pdf, which has to be saved and closed be the caller
-     *  
      * @throws IOException if something went wrong
      */
-    public PDDocument overlay(Map<Integer, String> specificPageOverlayFile)
-            throws IOException
+    public PDDocument overlay(Map<Integer, String> specificPageOverlayFile) throws
IOException
     {
         Map<String, PDDocument> loadedDocuments = new HashMap<String, PDDocument>();
         Map<PDDocument, LayoutPage> layouts = new HashMap<PDDocument, LayoutPage>();
@@ -519,8 +519,10 @@ public class Overlay
 
     /**
      * Sets the file to be overlayed.
-     * 
-     * @param inputFile the file to be overlayed
+     *
+     * @param inputFile the file to be overlayed. The {@link PDDocument} object gathered
from
+     * opening this file will be returned by
+     * {@link #overlay(java.util.Map) overlay(Map<Integer, String>)}.
      */
     public void setInputFile(String inputFile)
     {
@@ -529,8 +531,9 @@ public class Overlay
 
     /**
      * Sets the PDF to be overlayed.
-     * 
-     * @param inputPDF the PDF to be overlayed
+     *
+     * @param inputPDF the PDF to be overlayed. This will be the object that is returned
by
+     * {@link #overlay(java.util.Map) overlay(Map<Integer, String>)}.
      */
     public void setInputPDF(PDDocument inputPDF)
     {



Mime
View raw message