From b0457b37e2af4d782f38532f41d50418236e6780 Mon Sep 17 00:00:00 2001 From: m-holger Date: Wed, 7 Dec 2022 10:07:51 +0000 Subject: Update doc comment for QPDF::fixDanglingReferences --- include/qpdf/QPDF.hh | 19 ++++++++++--------- 1 file 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); -- cgit v1.2.3-70-g09d2