diff options
author | m-holger <m-holger@kubitscheck.org> | 2022-12-07 11:07:51 +0100 |
---|---|---|
committer | Jay Berkenbilt <jberkenbilt@users.noreply.github.com> | 2022-12-31 15:28:28 +0100 |
commit | b0457b37e2af4d782f38532f41d50418236e6780 (patch) | |
tree | 1c30bb59500d91bfa4e3b6f0032bf75908db41e2 /include | |
parent | 0ca44ef84ce48a2916095f66c219d2b112ce31e8 (diff) | |
download | qpdf-b0457b37e2af4d782f38532f41d50418236e6780.tar.zst |
Update doc comment for QPDF::fixDanglingReferences
Diffstat (limited to 'include')
-rw-r--r-- | include/qpdf/QPDF.hh | 19 |
1 files changed, 10 insertions, 9 deletions
diff --git a/include/qpdf/QPDF.hh b/include/qpdf/QPDF.hh index 5b2db6a8..79dcca59 100644 --- a/include/qpdf/QPDF.hh +++ b/include/qpdf/QPDF.hh @@ -713,15 +713,16 @@ class QPDF QPDF_DLL void showXRefTable(); - // Detect all indirect references to objects that don't exist and - // resolve them by replacing them with null, which is how the PDF - // spec says to interpret such dangling references. This method is - // called automatically if you try to add any new objects, if you - // call getAllObjects, and before a file is written. The qpdf - // object caches whether it has run this to avoid running it - // multiple times. You can pass true to force it to run again if - // you have explicitly added new objects that may have additional - // dangling references. + // Starting from qpdf 11.0 user code should not need to call this method. + // Before 11.0 this method was used to detect all indirect references to + // objects that don't exist and resolve them by replacing them with null, + // which is how the PDF spec says to interpret such dangling references. + // This method is called automatically when you try to add any new objects, + // if you call getAllObjects, and before a file is written. The qpdf object + // caches whether it has run this to avoid running it multiple times. + // Before 11.2.1 you could pass true to force it to run again if you had + // explicitly added new objects that may have additional dangling + // references. QPDF_DLL void fixDanglingReferences(bool force = false); |