aboutsummaryrefslogtreecommitdiffstats
path: root/include/qpdf/QPDFWriter.hh
diff options
context:
space:
mode:
authorJay Berkenbilt <ejb@ql.org>2017-08-22 00:53:14 +0200
committerJay Berkenbilt <ejb@ql.org>2017-08-22 03:05:44 +0200
commit4b908ade7079d9d7632a9ee0de3ce9c09a418fc4 (patch)
tree0a2fa152a75e864f5ae0e139677f8af6bec7ac93 /include/qpdf/QPDFWriter.hh
parentadbcfcff2d4488fdef11226b98ec22e4fc785249 (diff)
downloadqpdf-4b908ade7079d9d7632a9ee0de3ce9c09a418fc4.tar.zst
Update header documentation and ChangeLog entry for PCLm
Diffstat (limited to 'include/qpdf/QPDFWriter.hh')
-rw-r--r--include/qpdf/QPDFWriter.hh9
1 files changed, 7 insertions, 2 deletions
diff --git a/include/qpdf/QPDFWriter.hh b/include/qpdf/QPDFWriter.hh
index 0ab2f2ad..59a0dd98 100644
--- a/include/qpdf/QPDFWriter.hh
+++ b/include/qpdf/QPDFWriter.hh
@@ -353,8 +353,13 @@ class QPDFWriter
QPDF_DLL
void setLinearization(bool);
- // Create PCLm output. Enables writing unreferenced objects,
- // set PCLm header and writes pages before file catalog and page tree.
+ // Create PCLm output. This is only useful for clients that know
+ // how to create PCLm files. If a file is structured exactly as
+ // PCLm requires, this call will tell QPDFWriter to write the PCLm
+ // header, create certain unreferenced streams required by the
+ // standard, and write the objects in the required order. Calling
+ // this on an ordinary PDF serves no purpose. There is no
+ // command-line argument that causes this method to be called.
QPDF_DLL
void setPCLm(bool);