Commit 3d5d42efaf5abc176d8d8fd5a708368654ccdf8e

Authored by Jay Berkenbilt
1 parent a372a988

Fix errors introduced by pandoc

These showed up as warnings from sphinx-build
Showing 1 changed file with 18 additions and 21 deletions
manual/index.rst
... ... @@ -2230,8 +2230,7 @@ the library itself is reading comments in
2230 2230  
2231 2231 All header files are installed in the
2232 2232 @1@filename@1@include/qpdf@2@filename@2@ directory. It is recommend that
2233   -you use ``#include
2234   - <qpdf/QPDF.hh>`` rather than adding
  2233 +you use ``#include <qpdf/QPDF.hh>`` rather than adding
2235 2234 @1@filename@1@include/qpdf@2@filename@2@ to your include path.
2236 2235  
2237 2236 When linking against the qpdf static library, you may also need to
... ... @@ -2882,8 +2881,8 @@ common when switching between signed and unsigned characters. A lot of
2882 2881 qpdf's code uses unsigned characters internally, but ``std::string`` and
2883 2882 ``char`` are signed. Using ``QIntC::to_char`` would be wrong for
2884 2883 converting from unsigned to signed characters because a negative
2885   -``char`` value and the corresponding ``unsigned
2886   - char`` value greater than 127 *mean the same thing*. There are also
  2884 +``char`` value and the corresponding ``unsigned char`` value greater
  2885 +than 127 *mean the same thing*. There are also
2887 2886 cases in which we use ``static_cast`` when working with bit fields where
2888 2887 we are not representing a numerical value but rather a bunch of bits
2889 2888 packed together in some integer type. Also note that ``size_t`` and
... ... @@ -2896,12 +2895,13 @@ platforms, and the test suite is very thorough, so it is hard to make
2896 2895 any of the potential errors here without being caught in build or test.
2897 2896  
2898 2897 Non-const ``unsigned char*`` is used in the ``Pipeline`` interface. The
2899   -pipeline interface has a ``write`` call that uses ``unsigned
2900   - char*`` without a ``const`` qualifier. The main reason for this is
  2898 +pipeline interface has a ``write`` call that uses ``unsigned char*``
  2899 +without a ``const`` qualifier. The main reason for this is
2901 2900 to support pipelines that make calls to third-party libraries, such as
2902 2901 zlib, that don't include ``const`` in their interfaces. Unfortunately,
2903   -there are many places in the code where it is desirable to have ``const
2904   - char*`` with pipelines. None of the pipeline implementations in qpdf
  2902 +there are many places in the code where it is desirable to have
  2903 +``const char*`` with pipelines. None of the pipeline implementations
  2904 +in qpdf
2905 2905 currently modify the data passed to write, and doing so would be counter
2906 2906 to the intent of ``Pipeline``, but there is nothing in the code to
2907 2907 prevent this from being done. There are places in the code where
... ... @@ -3589,17 +3589,14 @@ type is &quot;``1``&quot;. All other default values are &quot;``0``&quot;.
3589 3589  
3590 3590 PDF 1.5 has three field types:
3591 3591  
3592   -- 0: for free objects. Format: ``0 obj
3593   - next-generation``, same as the free table in a traditional
3594   - cross-reference table
  3592 +- 0: for free objects. Format: ``0 obj next-generation``, same as the
  3593 + free table in a traditional cross-reference table
3595 3594  
3596   -- 1: regular non-compressed object. Format: ``1 offset
3597   - generation``
  3595 +- 1: regular non-compressed object. Format: ``1 offset generation``
3598 3596  
3599   -- 2: for objects in object streams. Format: ``2
3600   - object-stream-number index``, the number of object stream
3601   - containing the object and the index within the object stream of the
3602   - object.
  3597 +- 2: for objects in object streams. Format: ``2 object-stream-number
  3598 + index``, the number of object stream containing the object and the
  3599 + index within the object stream of the object.
3603 3600  
3604 3601 It seems standard to have the first entry in the table be ``0 0 0``
3605 3602 instead of ``0 0 ffff`` if there are no deleted objects.
... ... @@ -4171,8 +4168,8 @@ For a detailed list of changes, please see the file
4171 4168 script. Some distributions' packaging standards recommended the
4172 4169 use of this option.
4173 4170  
4174   - - Selection of a printf format string for ``long
4175   - long`` has been moved from ``ifdefs`` to an autoconf
  4171 + - Selection of a printf format string for ``long long`` has
  4172 + been moved from ``ifdefs`` to an autoconf
4176 4173 test. If you are using your own build system, you will need to
4177 4174 provide a value for ``LL_FMT`` in
4178 4175 @1@filename@1@libqpdf/qpdf/qpdf-config.h@2@filename@2@, which
... ... @@ -4559,8 +4556,8 @@ For a detailed list of changes, please see the file
4559 4556 - When parsing content streams with
4560 4557 ``QPDFObjectHandle::ParserCallbacks``, in place of the method
4561 4558 ``handleObject(QPDFObjectHandle)``, the developer may override
4562   - ``handleObject(QPDFObjectHandle, size_t offset,
4563   - size_t length)``. If this method is defined, it will
  4559 + ``handleObject(QPDFObjectHandle, size_t offset, size_t
  4560 + length)``. If this method is defined, it will
4564 4561 be invoked with the object along with its offset and length
4565 4562 within the overall contents being parsed. Intervening spaces
4566 4563 and comments are not included in offset and length.
... ...