Fix doc typos

m-holger · Jay Berkenbilt
1 parent 68e4aec0
Showing 5 changed files with 23 additions and 23 deletions
include/qpdf/PointerHolder.hh
include/qpdf/QPDFObjectHandle.hh
manual/design.rst
manual/qpdf-job.rst
manual/release-notes.rst
@@ -118,7 +118,7 @@
 // POINTERHOLDER_TRANSITION = 3
 //
-// Warn for all use of PointerHolder<T>. This help you remove all use
+// Warn for all use of PointerHolder<T>. This helps you remove all use
 // of PointerHolder from your code and use std::shared_ptr instead.
 // You will also have to transition any containers of PointerHolder in
 // your code.
@@ -149,7 +149,7 @@ class QPDFObjectHandle
     // representation of the token. For a string, this means that
     // there are no delimiters, and for a name, it means that all
     // escaping (# followed by two hex digits) has been resolved.
-    // qpdf's internal representation of name includes the leading
+    // qpdf's internal representation of a name includes the leading
     // slash. As such, you can't write the value of token.getValue()
     // directly to output that is supposed to be valid PDF syntax. If
     // you want to do that, you need to call writeToken() instead, or
@@ -163,8 +163,8 @@ class QPDFObjectHandle
     // writeToken(). Example:
     // writeToken(QPDFTokenizer::Token(QPDFTokenizer::tt_name, "/text/plain"))
     // would write `/text#2fplain`, and
-    // writeToken(QPDFTokenizer::Token(QPDFTokenizer::tt_string, "a\\(b"))
-    // would write `(a\(b)`
+    // writeToken(QPDFTokenizer::Token(QPDFTokenizer::tt_string, "a\\(b)")
+    // would write `(a\(b)`.
     class QPDF_DLL_CLASS TokenFilter
     {
       public:
@@ -531,7 +531,7 @@ class QPDFObjectHandle
     // PDF name is a sequence of bytes, excluding the NUL character,
     // and starting with a slash. Name objects as represented in the
     // PDF specification can contain characters escaped with #, but
-    // such escaping is not of concern calling QPDFObjectHandle
+    // such escaping is not of concern when calling QPDFObjectHandle
     // methods not directly relating to parsing. For example,
     // newName("/text/plain").getName() and
     // parse("/text#2fplain").getName() both return "/text/plain",
@@ -955,7 +955,7 @@ class QPDFObjectHandle
     QPDF_DLL
     QPDF* getOwningQPDF();
-    // Create a shallow of an object as a direct object, but do not
+    // Create a shallow copy of an object as a direct object, but do not
     // traverse across indirect object boundaries. That means that,
     // for dictionaries and arrays, any keys or items that were
     // indirect objects will still be indirect objects that point to
@@ -130,7 +130,7 @@ classes are intended to contain higher level APIs that allow developers
 to work with certain document constructs at an abstraction level above
 that of ``QPDFObjectHandle`` while staying true to qpdf's philosophy of
 not hiding document structure from the developer. As with qpdf in
-general, the goal is take away some of the more tedious bookkeeping
+general, the goal is to take away some of the more tedious bookkeeping
 aspects of working with PDF files, not to remove the need for the
 developer to understand how the PDF construction in question works. The
 driving factor behind the creation of helper classes was to allow the
@@ -751,7 +751,7 @@ actually quite rare and largely avoidable.
 Smart Pointers
 --------------
-This section describes changes to the use of smart pointers there were
+This section describes changes to the use of smart pointers that were
 made in qpdf 10.6.0 as well as some planned for 11.0.0.
 Starting in qpdf 11, ``PointerHolder`` will be replaced with
@@ -886,7 +886,7 @@ switching from ``PointerHolder`` to ``std::shared_ptr``:
 To use ``POINTERHOLDER_TRANSITION``, you will need to ``#define`` it
 before including any qpdf header files or specify its value as part of
 your build. The table below describes the values of
-``POINTERHOLDER_TRANSITION``. This informatoin is also summarized in
+``POINTERHOLDER_TRANSITION``. This information is also summarized in
 :file:`include/qpdf/PointerHolder.hh`, so you will have it handy
 without consulting this manual.
@@ -898,10 +898,10 @@ without consulting this manual.
      - meaning
    - - undefined
-     - same as ``0``, but start with qpdf 11.0, issues a warning
+     - Same as ``0``, but starting with qpdf 11.0, issues a warning
    - - ``0``
-     - provide a backward compatible ``PointerHolder`` and suppress
+     - Provide a backward compatible ``PointerHolder`` and suppress
        all deprecation warnings
    - - ``1``
@@ -911,10 +911,10 @@ without consulting this manual.
      - Deprecate ``getPointer()`` and ``getRefcount()``
    - - ``3``
-     - Starting in qpdf 11, deprecate all uses of ``PointerHolder``
+     - Starting with qpdf 11.0, deprecate all uses of ``PointerHolder``
    - - ``4``
-     - Starting in qpdf 11, disable all functionality from
+     - Starting with qpdf 11.0, disable all functionality from
        ``qpdf/PointerHolder.hh`` so that ``#include``-ing it has no
        effect.
@@ -1012,7 +1012,7 @@ After qpdf 11 is out
 In the 10.6 manual, this section represents a plan and is subject to
 change. However, it has been tested in practice using a version of the
 qpdf 11 ``PointerHolder`` on a branch, so it is likely to be accurate.
-In the meantime, think of this is a preview.
+In the meantime, think of this as a preview.
 First, make sure you have done the steps in the 10.6 section. (Note:
 once qpdf 11 comes out, the goal is to not have to migrate to 10.6
@@ -1090,8 +1090,8 @@ symbol. Here are the remaining changes.
 - Build and test. Fix any remaining issues.
-- If not supporting older qpdf, remove all references to
-  ``<qpdf/PointerHolder.hh>``. Otherwise, you wil still need to
+- If not supporting older versions of qpdf, remove all references to
+  ``<qpdf/PointerHolder.hh>``. Otherwise, you will still need to
   include it but can ``#define POINTERHOLDER_TRANSITION 4`` to prevent
   ``PointerHolder`` from being defined. The
   ``POINTERHOLDER_IS_SHARED_POINTER`` symbol will still be defined.
@@ -1102,6 +1102,6 @@ Historical Background
 Since its inception, the qpdf library used its own smart pointer
 class, ``PointerHolder``. The ``PointerHolder`` class was originally
 created long before ``std::shared_ptr`` existed, and qpdf itself
-didn't start requiring a C++11 compiler version 9.1.0 released in
-late 2019. With current C++ versions, is no longer desirable for qpdf
+didn't start requiring a C++11 compiler until version 9.1.0 released in
+late 2019. With current C++ versions, it is no longer desirable for qpdf
 to have its own smart pointer class.
@@ -184,10 +184,10 @@ This section describes some of the design rationale and history behind
 Documentation of ``QPDFJob`` is divided among three places:
 - "HOW TO ADD A COMMAND-LINE ARGUMENT" in :file:`README-maintainer`
-  provides a quick reminder of how to add a command-line argument
+  provides a quick reminder of how to add a command-line argument.
 - The source file :file:`generate_auto_job` has a detailed explanation
-  about how ``QPDFJob`` and ``generate_auto_job`` work together
+  about how ``QPDFJob`` and ``generate_auto_job`` work together.
 - This chapter of the manual has other details.
@@ -207,7 +207,7 @@ such. This created a number of problems:
 - Users of other languages who just wanted an interface to do things
   that the CLI could do didn't have a good way to do it, such as just
-  handling a library call a set of command-line options or an
+  handing a library call a set of command-line options or an
   equivalent JSON object that could be passed in as a string.
 - The qpdf CLI itself was almost 8,000 lines of code. It needed to be
@@ -12,7 +12,7 @@ For a detailed list of changes, please see the file
     The next major release of qpdf will replace ``PointerHolder`` with
     ``std::shared_ptr`` across all of qpdf's public API. No action is
     required at this time, but if you'd like to prepare, read the
-    comments :file:`include/qpdf/PointerHolder.hh` and see
+    comments in :file:`include/qpdf/PointerHolder.hh` and see
     :ref:`smart-pointers` for details on what you can do now to create
     code that will continue to work with older versions of qpdf and be
     easier to switch over to qpdf 11 when it comes out.
@@ -139,7 +139,7 @@ For a detailed list of changes, please see the file
       ``const`` argv array.
     - ``QPDF::emptyPDF`` has been exposed to the C API as
-      ``qpdf_empty_pdf``. This makes it possible to create PDF from
+      ``qpdf_empty_pdf``. This makes it possible to create a PDF from
       scratch with the C API.
     - New C API functions ``qpdf_oh_get_binary_utf8_value`` and