From commits-return-14498-archive-asf-public=cust-asf.ponee.io@pdfbox.apache.org Wed Apr 10 18:57:40 2019 Return-Path: X-Original-To: archive-asf-public@cust-asf.ponee.io Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [207.244.88.153]) by mx-eu-01.ponee.io (Postfix) with SMTP id E5CB5180626 for ; Wed, 10 Apr 2019 20:57:39 +0200 (CEST) Received: (qmail 2625 invoked by uid 500); 10 Apr 2019 18:57:38 -0000 Mailing-List: contact commits-help@pdfbox.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@pdfbox.apache.org Delivered-To: mailing list commits@pdfbox.apache.org Received: (qmail 2616 invoked by uid 99); 10 Apr 2019 18:57:38 -0000 Received: from Unknown (HELO svn01-us-west.apache.org) (209.188.14.144) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 10 Apr 2019 18:57:38 +0000 Received: from svn01-us-west.apache.org (localhost [127.0.0.1]) by svn01-us-west.apache.org (ASF Mail Server at svn01-us-west.apache.org) with ESMTP id 480A03A0543 for ; Wed, 10 Apr 2019 18:57:38 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1857274 - /pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocument.java Date: Wed, 10 Apr 2019 18:57:37 -0000 To: commits@pdfbox.apache.org From: tilman@apache.org X-Mailer: svnmailer-1.0.9 Message-Id: <20190410185738.480A03A0543@svn01-us-west.apache.org> Author: tilman Date: Wed Apr 10 18:57:36 2019 New Revision: 1857274 URL: http://svn.apache.org/viewvc?rev=1857274&view=rev Log: PDFBOX-45: improve javadoc 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=1857274&r1=1857273&r2=1857274&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 Wed Apr 10 18:57:36 2019 @@ -1344,6 +1344,10 @@ public class PDDocument implements Close * file or a stream, not if the document was created in PDFBox itself. There must be a path of * objects that have {@link COSUpdateInfo#isNeedToBeUpdated()} set, starting from the document * catalog. For signatures this is taken care by PDFBox itself. + *

+ * Other usages of this method are for experienced users only. You will usually never need it. + * It is useful only if you are required to keep the current revision and append the changes. A + * typical use case is changing a signed file without invalidating the signature. * * @param output stream to write to. It will be closed when done. It * must never point to the source file or that one will be