You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pdfbox.apache.org by ti...@apache.org on 2020/08/09 08:31:25 UTC

svn commit: r1880712 - /pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/multipdf/Overlay.java

Author: tilman
Date: Sun Aug  9 08:31:25 2020
New Revision: 1880712

URL: http://svn.apache.org/viewvc?rev=1880712&view=rev
Log:
PDFBOX-4892: improve javadoc

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=1880712&r1=1880711&r2=1880712&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 Sun Aug  9 08:31:25 2020
@@ -130,7 +130,8 @@ public class Overlay implements Closeabl
     }
 
     /**
-     * This will add overlays documents to a document.
+     * This will add overlays documents to a document. If you created the overlay documents with
+     * subsetted fonts, you need to save them first so that the subsetting gets done.
      *
      * @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
@@ -638,7 +639,8 @@ public class Overlay implements Closeabl
     }
 
     /**
-     * Sets the default overlay PDF.
+     * Sets the default overlay PDF. If you created the overlay document with
+     * subsetted fonts, you need to save it first so that the subsetting gets done.
      * 
      * @param defaultOverlayPDF the default overlay PDF
      */
@@ -668,7 +670,8 @@ public class Overlay implements Closeabl
     }
 
     /**
-     * Sets the first page overlay PDF.
+     * Sets the first page overlay PDF. If you created the overlay document with
+     * subsetted fonts, you need to save it first so that the subsetting gets done.
      * 
      * @param firstPageOverlayPDF the first page overlay PDF
      */
@@ -688,7 +691,8 @@ public class Overlay implements Closeabl
     }
 
     /**
-     * Sets the last page overlay PDF.
+     * Sets the last page overlay PDF. If you created the overlay document with
+     * subsetted fonts, you need to save it first so that the subsetting gets done.
      * 
      * @param lastPageOverlayPDF the last page overlay PDF
      */
@@ -708,7 +712,8 @@ public class Overlay implements Closeabl
     }
 
     /**
-     * Sets the all pages overlay PDF.
+     * Sets the all pages overlay PDF. If you created the overlay document with
+     * subsetted fonts, you need to save it first so that the subsetting gets done.
      * 
      * @param allPagesOverlayPDF the all pages overlay PDF. This should not be a PDDocument that you
      * created on the fly, it should be saved first, if it contains any fonts that are subset.
@@ -729,7 +734,8 @@ public class Overlay implements Closeabl
     }
 
     /**
-     * Sets the odd page overlay PDF.
+     * Sets the odd page overlay PDF. If you created the overlay document with
+     * subsetted fonts, you need to save it first so that the subsetting gets done.
      * 
      * @param oddPageOverlayPDF the odd page overlay PDF
      */
@@ -749,7 +755,8 @@ public class Overlay implements Closeabl
     }
 
     /**
-     * Sets the even page overlay PDF.
+     * Sets the even page overlay PDF. If you created the overlay document with
+     * subsetted fonts, you need to save it first so that the subsetting gets done.
      * 
      * @param evenPageOverlayPDF the even page overlay PDF
      */