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 2017/03/23 19:50:08 UTC

svn commit: r1788311 - /pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocument.java

Author: tilman
Date: Thu Mar 23 19:50:08 2017
New Revision: 1788311

URL: http://svn.apache.org/viewvc?rev=1788311&view=rev
Log:
PDFBOX-3730: clarify javadoc as suggested by Peter Pinnau

Modified:
    pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocument.java

Modified: pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocument.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocument.java?rev=1788311&r1=1788310&r2=1788311&view=diff
==============================================================================
--- pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocument.java (original)
+++ pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocument.java Thu Mar 23 19:50:08 2017
@@ -1225,7 +1225,8 @@ public class PDDocument implements Close
     /**
      * This will save the document to an output stream.
      * 
-     * @param output The stream to write to.
+     * @param output The stream to write to. It is recommended to wrap it in a
+     * {@link java.io.BufferedOutputStream}, unless it is already buffered.
      *
      * @throws IOException if the output could not be written
      */