Fix some doc typos

m-holger · Jay Berkenbilt
1 parent bc640370
Showing 5 changed files with 10 additions and 10 deletions
examples/pdf-custom-filter.cc
generate_auto_job
include/qpdf/JSON.hh
include/qpdf/qpdfjob-c.h
job.yml
@@ -14,7 +14,7 @@
 // uses the pattern of having the stream data provider class use a
 // second QPDF instance with copies of streams from the original QPDF
 // so that the stream data provider can access the original stream
-// data. This is implement very efficiently inside the qpdf library as
+// data. This is implemented very efficiently inside the qpdf library as
 // the second QPDF instance knows how to read the stream data from the
 // original input file, so no extra copies of the original stream data
 // are made.
@@ -196,7 +196,7 @@ class StreamReplacer: public QPDFObjectHandle::StreamDataProvider
     //   pipeline and passes nullptr to dict_updates. In this mode,
     //   the stream dictionary has already been altered, and the
     //   original stream data is no longer directly accessible. Trying
-    //   to retrieve the stream data would be an infinite loop because
+    //   to retrieve the stream data would cause an infinite loop because
     //   it would just end up calling provideStreamData again. This is
     //   why maybeReplace uses a stashed copy of the original stream.
  
@@ -54,7 +54,7 @@ from contextlib import contextmanager
 # developer or user can freely move among those different ways of
 # interacting with QPDFJob in a predictable fashion. In addition, help
 # information for each option appears in manual/cli.rst, and that
-# information is used in creation of the job JSON schema and to supply
+# information is used in the creation of the job JSON schema and to supply
 # help text to QPDFArgParser. This code also ensures that there is an
 # exact match between options in job.yml and options in cli.rst.
 #
@@ -170,7 +170,7 @@ class Main:
         'json_init': 'libqpdf/qpdf/auto_job_json_init.hh',
         # Others are added in top
     }
-    # SUBS contains a checksum for each source and destination and is
+    # SUMS contains a checksum for each source and destination and is
     # used to detect whether we're up to date without having to force
     # recompilation all the time. This way the build can invoke this
     # script unconditionally without causing stuff to rebuild every
@@ -25,12 +25,12 @@
 // This is a simple JSON serializer and parser, primarily designed for
 // serializing QPDF Objects as JSON. While it may work as a
 // general-purpose JSON parser/serializer, there are better options.
-// JSON objects contain their data as smart pointers. One JSON object
+// JSON objects contain their data as smart pointers. When one JSON object
 // is added to another, this pointer is copied. This means you can
 // create temporary JSON objects on the stack, add them to other
 // objects, and let them go out of scope safely. It also means that if
-// the json JSON object is added in more than one place, all copies
-// share underlying data. This makes them similar in structure and
+// a JSON object is added in more than one place, all copies
+// share the underlying data. This makes them similar in structure and
 // behavior to QPDFObjectHandle and may feel natural within the QPDF
 // codebase, but it is also a good reason not to use this as a
 // general-purpose JSON package.
@@ -105,7 +105,7 @@ class JSON
     //
     //   * The schema is a nested structure containing dictionaries,
     //     single-element arrays, and strings only.
-    //   * Recursively walk the schema
+    //   * Recursively walk the schema.
     //   * If the current value is a dictionary, this object must have
     //     a dictionary in the same place with the same keys. If flags
     //     contains f_optional, a key in the schema does not have to
@@ -56,7 +56,7 @@ extern &quot;C&quot; {
  
 #ifndef QPDF_NO_WCHAR_T
     /* This function is the same as qpdfjob_run_from_argv except argv
-     * is encoded with wide characters. This would suitable for
+     * is encoded with wide characters. This would be suitable for
      * calling from a Windows wmain function.
      */
     QPDF_DLL
@@ -259,7 +259,7 @@ json:
   # other information known by generate_auto_job. This information is
   # used to construct a "schema" (as in JSON.hh) for the json input to
   # QPDFJob. The leading underscore is removed. *NOTE*: all keys are
-  # converted to camelCase for the schema and must be appear that way
+  # converted to camelCase for the schema and must appear that way
   # in the user-supplied json. This makes it more convenient to
   # populate JSON objects in some languages.