Author: tilman
Date: Sat Mar 16 11:27:01 2019
New Revision: 1855633
URL: http://svn.apache.org/viewvc?rev=1855633&view=rev
Log:
PDFBOX-4071: improve javadoc, see SO 55018400
Modified:
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/multipdf/Overlay.java
Modified:
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/multipdf/Overlay.java
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/multipdf/Overlay.java?rev=1855633&r1=1855632&r2=1855633&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/multipdf/Overlay.java
(original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/multipdf/Overlay.java
Sat Mar 16 11:27:01 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)}
