Commit b8ec4395e740303c7046667f0c34478c8522520f

Authored by m-holger
Committed by Jay Berkenbilt
1 parent 09a36ad6

Minor manual fixes

manual/design.rst
@@ -105,7 +105,7 @@ and then reads the cross reference tables and trailer dictionaries. The @@ -105,7 +105,7 @@ and then reads the cross reference tables and trailer dictionaries. The
105 read all of them so it can check the ``/Prev`` key. ``QPDF`` class users 105 read all of them so it can check the ``/Prev`` key. ``QPDF`` class users
106 may request the root object and the trailer dictionary specifically. The 106 may request the root object and the trailer dictionary specifically. The
107 cross reference table is kept private. Objects may then be requested by 107 cross reference table is kept private. Objects may then be requested by
108 -number of by walking the object tree. 108 +number or by walking the object tree.
109 109
110 When a PDF file has a cross-reference stream instead of a 110 When a PDF file has a cross-reference stream instead of a
111 cross-reference table and trailer, requesting the document's trailer 111 cross-reference table and trailer, requesting the document's trailer
@@ -254,7 +254,7 @@ resulting ``QPDFObjectHandle``. The calling object handle then replaces @@ -254,7 +254,7 @@ resulting ``QPDFObjectHandle``. The calling object handle then replaces
254 its ``PointerHolder<QDFObject>`` with the one from the newly returned 254 its ``PointerHolder<QDFObject>`` with the one from the newly returned
255 ``QPDFObjectHandle``. In this way, only a single copy of any direct 255 ``QPDFObjectHandle``. In this way, only a single copy of any direct
256 object need exist and clients can access objects transparently without 256 object need exist and clients can access objects transparently without
257 -knowing caring whether they are direct or indirect objects. 257 +knowing or caring whether they are direct or indirect objects.
258 Additionally, no object is ever read from the file more than once. That 258 Additionally, no object is ever read from the file more than once. That
259 means that only the portions of the PDF file that are actually needed 259 means that only the portions of the PDF file that are actually needed
260 are ever read from the input file, thus allowing the qpdf package to 260 are ever read from the input file, thus allowing the qpdf package to
@@ -264,7 +264,7 @@ If the requested object is inside of an object stream, the object stream @@ -264,7 +264,7 @@ If the requested object is inside of an object stream, the object stream
264 itself is first read into memory. Then the tokenizer reads objects from 264 itself is first read into memory. Then the tokenizer reads objects from
265 the memory stream based on the offset information stored in the stream. 265 the memory stream based on the offset information stored in the stream.
266 Those individual objects are cached, after which the temporary buffer 266 Those individual objects are cached, after which the temporary buffer
267 -holding the object stream contents are discarded. In this way, the first 267 +holding the object stream contents is discarded. In this way, the first
268 time an object in an object stream is requested, all objects in the 268 time an object in an object stream is requested, all objects in the
269 stream are cached. 269 stream are cached.
270 270
manual/library.rst
@@ -10,7 +10,7 @@ Using QPDF from C++ @@ -10,7 +10,7 @@ Using QPDF from C++
10 10
11 The source tree for the qpdf package has an 11 The source tree for the qpdf package has an
12 :file:`examples` directory that contains a few 12 :file:`examples` directory that contains a few
13 -example programs. The :file:`qpdf/qpdf.cc` source 13 +example programs. The :file:`libqpdf/QPDFJob.cc` source
14 file also serves as a useful example since it exercises almost all of 14 file also serves as a useful example since it exercises almost all of
15 the qpdf library's public interface. The best source of documentation on 15 the qpdf library's public interface. The best source of documentation on
16 the library itself is reading comments in 16 the library itself is reading comments in
@@ -86,6 +86,6 @@ converted to ``wchar_t*``, and Unicode-aware Windows APIs are used. As @@ -86,6 +86,6 @@ converted to ``wchar_t*``, and Unicode-aware Windows APIs are used. As
86 such, qpdf will generally operate properly on files with non-ASCII 86 such, qpdf will generally operate properly on files with non-ASCII
87 characters in their names as long as the filenames are UTF-8 encoded for 87 characters in their names as long as the filenames are UTF-8 encoded for
88 passing into the qpdf library API, but there are still some rough edges, 88 passing into the qpdf library API, but there are still some rough edges,
89 -such as the encoding of the filenames in error messages our CLI output 89 +such as the encoding of the filenames in error messages or CLI output
90 messages. Patches or bug reports are welcome for any continuing issues 90 messages. Patches or bug reports are welcome for any continuing issues
91 with Unicode file names in Windows. 91 with Unicode file names in Windows.