octoleo/qpdf
2
1
Fork 0
mirror of https://github.com/qpdf/qpdf.git synced 2024-12-22 19:08:59 +00:00
Code Issues Releases Wiki Activity

Update doc comment for QPDF::fixDanglingReferences

Browse Source
This commit is contained in:
m-holger 2022-12-07 10:07:51 +00:00 committed by Jay Berkenbilt
parent 0ca44ef84c
commit b0457b37e2
1 changed files with 10 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
include/qpdf/QPDF.hh
View File

@ -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);