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

[ti...@apache.org]

Author: tilman
Date: Thu Feb 18 19:27:06 2016
New Revision: 1731122

URL: http://svn.apache.org/viewvc?rev=1731122&view=rev
Log:
PDFBOX-2852: clarify 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=1731122&r1=1731121&r2=1731122&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 Thu Feb 18 19:27:06 2016
@@ -159,7 +159,9 @@ public final class PDPageContentStream i
      * @param appendContent Indicates whether content will be overwritten. If false all previous
      *                      content is deleted.
      * @param compress Tell if the content stream should compress the page contents.
-     * @param resetContext Tell if the graphic context should be reseted.
+     * @param resetContext Tell if the graphic context should be reseted. You should use this when
+     * appending to an existing stream, because the existing stream may have changed graphic
+     * properties (e.g. scaling, rotation).
      * @throws IOException If there is an error writing to the page contents.
      * @deprecated use {@link #PDPageContentStream(PDDocument, PDPage, PDPageContentStream.AppendMode, boolean, boolean) }
      */
@@ -177,8 +179,10 @@ public final class PDPageContentStream i
      * @param sourcePage The page to write the contents to.
      * @param appendContent Indicates whether content will be overwritten, appended or prepended.
      * @param compress Tell if the content stream should compress the page contents.
-     * @param resetContext Tell if the graphic context should be reset. This is only relevant
-     *                     when the appendContent parameter is set to {@link AppendMode#APPEND}.
+     * @param resetContext Tell if the graphic context should be reset. This is only relevant when
+     * the appendContent parameter is set to {@link AppendMode#APPEND}. You should use this when
+     * appending to an existing stream, because the existing stream may have changed graphic
+     * properties (e.g. scaling, rotation).
      * @throws IOException If there is an error writing to the page contents.
      */
     public PDPageContentStream(PDDocument document, PDPage sourcePage, AppendMode appendContent,