Commit 28441124e56ba8d981df6654a4c989b3cfbd2c9e

Authored by m-holger
1 parent 8c309031

Apply suggestions from code review

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
include/qpdf/Constants.h
@@ -256,7 +256,7 @@ enum qpdf_result_e { @@ -256,7 +256,7 @@ enum qpdf_result_e {
256 /* success */ 256 /* success */
257 qpdf_r_ok = 0, 257 qpdf_r_ok = 0,
258 qpdf_r_no_warn = 0xff, /// any result <= qpdf_no_warn indicates success without warning 258 qpdf_r_no_warn = 0xff, /// any result <= qpdf_no_warn indicates success without warning
259 - qpdf_r_success = 0xffff, /// any result <= qpdf_no_warn indicates success 259 + qpdf_r_success = 0xffff, /// any result <= qpdf_r_success indicates success
260 /* failure */ 260 /* failure */
261 qpdf_r_bad_parameter = 0x10000, 261 qpdf_r_bad_parameter = 0x10000,
262 262
@@ -270,7 +270,7 @@ enum qpdf_result_e { @@ -270,7 +270,7 @@ enum qpdf_result_e {
270 * functions. 270 * functions.
271 * 271 *
272 * The enum values are grouped into sections based on their functionality, such as global 272 * The enum values are grouped into sections based on their functionality, such as global
273 - * options or global limits.For the meaning of individual parameters see `qpdf/global.cc` 273 + * options or global limits. For the meaning of individual parameters see `qpdf/global.cc`
274 */ 274 */
275 enum qpdf_param_e { 275 enum qpdf_param_e {
276 /* global state */ 276 /* global state */
include/qpdf/QUtil.hh
@@ -447,7 +447,7 @@ namespace QUtil @@ -447,7 +447,7 @@ namespace QUtil
447 /// 447 ///
448 /// **For qpdf internal use only - not part of the public API** 448 /// **For qpdf internal use only - not part of the public API**
449 /// @par 449 /// @par
450 - /// Depending on the result code, either continues execution, checks or throws an 450 + /// Depending on the result code, either continues execution or throws an
451 /// exception in case of an invalid parameter. 451 /// exception in case of an invalid parameter.
452 /// 452 ///
453 /// @param result The result code of type qpdf_result_e, indicating success or failure status. 453 /// @param result The result code of type qpdf_result_e, indicating success or failure status.
include/qpdf/global.hh
@@ -56,7 +56,7 @@ namespace qpdf::global @@ -56,7 +56,7 @@ namespace qpdf::global
56 56
57 /// @brief Retrieves the number of limit errors. 57 /// @brief Retrieves the number of limit errors.
58 /// 58 ///
59 - /// Returns the number a global limit was exceeded. This item is reaf only. 59 + /// Returns the number a global limit was exceeded. This item is read only.
60 /// 60 ///
61 /// @return The number of limit errors. 61 /// @return The number of limit errors.
62 /// 62 ///
manual/release-notes.rst
@@ -62,7 +62,7 @@ more detail. @@ -62,7 +62,7 @@ more detail.
62 62
63 - Add various new functions in the ``qpdf::`global`` namespace to access 63 - Add various new functions in the ``qpdf::`global`` namespace to access
64 and set/modify global settings and limits. See :ref:`global-options` 64 and set/modify global settings and limits. See :ref:`global-options`
65 - and header file ``qpdf\global.hh`` for further detail. 65 + and header file ``qpdf/global.hh`` for further detail.
66 66
67 - Add new C-API functions ``qpdf_global_get_uint32`` and 67 - Add new C-API functions ``qpdf_global_get_uint32`` and
68 ``qpdf_global_set_uint32`` to access and set/modify various global 68 ``qpdf_global_set_uint32`` to access and set/modify various global