Update header documentation and ChangeLog entry for PCLm

Jay Berkenbilt
1 parent adbcfcff
Showing 2 changed files with 17 additions and 2 deletions
ChangeLog
include/qpdf/QPDFWriter.hh
+2017-08-21  Jay Berkenbilt  <ejb@ql.org>
+
+	* Add support for writing PCLm files. Most of the work was done by
+	Sahil Arora <sahilarora.535@gmail.com> as part of a Google Summer
+	of Code project in 2017. PCLm support is useful only for clients
+	that specifically know how to create PCLm files. Support in qpdf
+	is just for ensuring that objects are written in the correct order
+	and for including some additional material in the output that is
+	required by the PCLm standard.
+
 2017-08-19  Jay Berkenbilt  <ejb@ql.org>
  
 	* Remove --precheck-streams. This is enabled by default now
@@ -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);