svn commit: r1802412 - /pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDPageContentStream.java

[ti...@apache.org]

Author: tilman
Date: Wed Jul 19 17:02:49 2017
New Revision: 1802412

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

Modified:
    pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDPageContentStream.java

Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDPageContentStream.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDPageContentStream.java?rev=1802412&r1=1802411&r2=1802412&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDPageContentStream.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDPageContentStream.java Wed Jul 19 17:02:49 2017
@@ -92,7 +92,8 @@ public final class PDPageContentStream e
     private final Stack<PDColorSpace> strokingColorSpaceStack = new Stack<>();
 
     /**
-     * Create a new PDPage content stream.
+     * Create a new PDPage content stream. This constructor overwrites all existing content streams
+     * of this page.
      *
      * @param document The document the page is part of.
      * @param sourcePage The page to write the contents to.
@@ -122,7 +123,10 @@ public final class PDPageContentStream e
     }
 
     /**
-     * Create a new PDPage content stream.
+     * Create a new PDPage content stream. If the appendContent parameter is set to
+     * {@link AppendMode#APPEND}, you may want to use
+     * {@link #PDPageContentStream(PDDocument, PDPage, PDPageContentStream.AppendMode, boolean, boolean)}
+     * instead, with the fifth parameter set to true.
      *
      * @param document The document the page is part of.
      * @param sourcePage The page to write the contents to.