pdfbox-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From til...@apache.org
Subject svn commit: r1855632 - /pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/multipdf/Overlay.java
Date Sat, 16 Mar 2019 11:26:56 GMT
Author: tilman
Date: Sat Mar 16 11:26:56 2019
New Revision: 1855632

URL: http://svn.apache.org/viewvc?rev=1855632&view=rev
Log:
PDFBOX-4071: improve javadoc, see SO 55018400

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=1855632&r1=1855631&r2=1855632&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 Mar
16 11:26:56 2019
@@ -96,8 +96,8 @@ public class Overlay implements Closeabl
     /**
      * This will add overlays to a document.
      *
-     * @param specificPageOverlayFile map of overlay files for specific pages. The page numbers
are
-     * 1-based.
+     * @param specificPageOverlayFile Optional map of overlay files for specific pages. The
page
+     * numbers are 1-based. The map must be empty (but not null) if no specific mappings
are used.
      *
      * @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)}
@@ -129,8 +129,9 @@ public class Overlay implements Closeabl
     /**
      * This will add overlays documents to a document.
      *
-     * @param specificPageOverlayDocuments map of overlay documents for specific pages. The
page
-     * numbers are 1-based.
+     * @param specificPageOverlayDocuments Optional map of overlay documents for specific
pages. The
+     * page numbers are 1-based. The map must be empty (but not null) if no specific mappings
are
+     * used.
      *
      * @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)}



Mime
View raw message