Minor documentation updates

m-holger · Jay Berkenbilt
1 parent b4fc9eb7
Showing 7 changed files with 19 additions and 19 deletions
include/qpdf/QPDF.hh
include/qpdf/QPDFObjectHandle.hh
include/qpdf/QPDFPageDocumentHelper.hh
include/qpdf/qpdf-c.h
manual/qpdf-manual.xml
qpdf/qpdf.cc
qpdf/qtest/qpdf/split-pages-stdout.out
@@ -595,7 +595,7 @@ class QPDF
     // duplicated. For efficiency, this method returns a const
     // reference to an internal vector of pages. Calls to addPage,
     // addPageAt, and removePage safely update this, but directly
-    // manipulation of the pages three or pushing inheritable objects
+    // manipulation of the pages tree or pushing inheritable objects
     // to the page level may invalidate it. See comments for
     // updateAllPagesCache() for additional notes. Newer code should
     // use QPDFPageDocumentHelper::getAllPages instead. The decision
@@ -320,7 +320,7 @@ class QPDFObjectHandle
     QPDF_DLL
     char const* getTypeName();
-    // Exactly one of these will return true for any object.  Operator
+    // Exactly one of these will return true for any initialized object.  Operator
     // and InlineImage are only allowed in content streams.
     QPDF_DLL
     bool isBool();
@@ -594,7 +594,7 @@ class QPDFObjectHandle
     static QPDFObjectHandle newReserved(QPDF* qpdf);
     // Provide an owning qpdf and object description. The library does
-    // this automatically with objects that are read from from the
+    // this automatically with objects that are read from the
     // input PDF and with objects that are created programmatically
     // and inserted into the QPDF by adding them to an array or a
     // dictionary or creating a new indirect object. Most end user
@@ -648,7 +648,7 @@ class QPDFObjectHandle
     // with PDF Doc Encoding. PDF Doc Encoding is identical to
     // ISO-8859-1 except in the range from 0200 through 0240, where
     // there is a mapping of characters to Unicode. QPDF versions
-    // prior to version erroneously left characters in that range
+    // prior to version 8.0.0 erroneously left characters in that range
     // unmapped.
     QPDF_DLL
     std::string getUTF8Value();
@@ -684,13 +684,13 @@ class QPDFObjectHandle
     std::vector<QPDFObjectHandle> getArrayAsVector();
     QPDF_DLL
     bool isRectangle();
-    // If the array an array of four numeric values, return as a
+    // If the array is an array of four numeric values, return as a
     // rectangle. Otherwise, return the rectangle [0, 0, 0, 0]
     QPDF_DLL
     Rectangle getArrayAsRectangle();
     QPDF_DLL
     bool isMatrix();
-    // If the array an array of six numeric values, return as a
+    // If the array is an array of six numeric values, return as a
     // matrix. Otherwise, return the matrix [1, 0, 0, 1, 0, 0]
     QPDF_DLL
     Matrix getArrayAsMatrix();
@@ -46,11 +46,11 @@ class QPDFPageDocumentHelper: public QPDFDocumentHelper
     // Traverse page tree, and return all /Page objects wrapped in
     // QPDFPageObjectHelper objects. Unlike with
-    // QPDFObjectHandle::getAllPages, the vector of pages returned by
+    // QPDF::getAllPages, the vector of pages returned by
     // this call is not affected by additions or removals of pages. If
     // you manipulate pages, you will have to call this again to get a
-    // new copy. Please comments in QPDFObjectHandle.hh for
-    // getAllPages() for additional details.
+    // new copy. Please see comments in QPDF.hh for getAllPages() for
+    // additional details.
     QPDF_DLL
     std::vector<QPDFPageObjectHelper> getAllPages();
@@ -502,7 +502,7 @@ extern &quot;C&quot; {
      * specific method of QPDFObjectHandler. For example,
      * qpdf_oh_is_bool corresponds to QPDFObjectHandle::isBool. If the
      * C++ method is overloaded, the C function's name will be
-     * disambiguated. If the C++ method takes optional argumens, the C
+     * disambiguated. If the C++ method takes optional arguments, the C
      * function will have required arguments in those positions. For
      * details about the method, please see comments in
      * QPDFObjectHandle.hh. Comments here only explain things that are
@@ -527,7 +527,7 @@ extern &quot;C&quot; {
      * expected to be valid after the next qpdf call.
      *
      * The qpdf_data object keeps a cache of handles returned by these
-     * functions. Once you are finished referencing an handle, you can
+     * functions. Once you are finished referencing a handle, you can
      * optionally release it. Releasing handles is optional since they
      * will all get released by qpdf_cleanup, but it can help to
      * reduce the memory footprint of the qpdf_data object to release
@@ -538,8 +538,8 @@ extern &quot;C&quot; {
      * add it to an existing dictionary or array, and then release it's
      * handle, the object is safely part of the dictionary or array.
      * Similarly, any other object handle refering to the object remains
-     * valid. Explicitly releasing an object is essentially the same as
-     * letting a QPDFObjectHandle go out of scope in the C++ API.
+     * valid. Explicitly releasing an object handle is essentially the
+     * same as letting a QPDFObjectHandle go out of scope in the C++ API.
      */
     /* For examples of using this API, see examples/pdf-c-objects.c */
@@ -556,7 +556,7 @@ make
    <para>
     When running qpdf, the basic invocation is as follows:
-    <programlisting><command>qpdf</command><option> [ <replaceable>options</replaceable> ] <replaceable>infilename</replaceable> [ <replaceable>outfilename</replaceable> ]</option>
+    <programlisting><command>qpdf</command><option> [ <replaceable>options</replaceable> ] { <replaceable>infilename</replaceable> | <option>--empty</option> } [ <replaceable>page_selection_options</replaceable> ] <replaceable>outfilename</replaceable></option>
 </programlisting>
     This converts PDF file <option>infilename</option> to PDF file
     <option>outfilename</option>.  The output file is functionally
@@ -1551,7 +1551,7 @@ make
    </para>
    <para>
     Starting with qpf 8.4, the special input file name
-    &ldquo;<filename>.</filename>&rdquo; can be used shortcut for the
+    &ldquo;<filename>.</filename>&rdquo; can be used as a shortcut for the
     primary input filename.
    </para>
    <para>
@@ -1300,7 +1300,7 @@ ArgParser::argCopyright()
         << std::endl
         << "QPDF is licensed under the Apache License, Version 2.0 (the \"License\");"
         << std::endl
-        << "not use this file except in compliance with the License."
+        << "you may not use this file except in compliance with the License."
         << std::endl
         << "You may obtain a copy of the License at"
         << std::endl
@@ -1334,7 +1334,7 @@ ArgParser::argHelp()
 {
     std::cout
         // 12345678901234567890123456789012345678901234567890123456789012345678901234567890
-        << "Usage: qpdf [ options ] { infilename | --empty } [ outfilename ]\n"
+        << "Usage: qpdf [options] {infile | --empty} [page_selection_options] outfile\n"
         << "\n"
         << "An option summary appears below.  Please see the documentation for details.\n"
         << "\n"
@@ -3114,7 +3114,7 @@ void usageExit(std::string const&amp; msg)
 	<< std::endl
 	<< whoami << ": " << msg << std::endl
 	<< std::endl
-	<< "Usage: " << whoami << " [options] infile outfile" << std::endl
+	<< "Usage: " << whoami << " [options] {infile | --empty} [page_selection_options] outfile" << std::endl
 	<< "For detailed help, run " << whoami << " --help" << std::endl
 	<< std::endl;
     exit(EXIT_ERROR);
 qpdf: --split-pages may not be used when writing to standard output
-Usage: qpdf [options] infile outfile
+Usage: qpdf [options] {infile | --empty} [page_selection_options] outfile
 For detailed help, run qpdf --help