Add example of name/number trees and dictionary/array iteration

3 files changed, 12 insertions, 0 deletions

diff --git a/include/qpdf/QPDFNameTreeObjectHelper.hh b/include/qpdf/QPDFNameTreeObjectHelper.hh
index 866d0efd..c2430adb 100644
--- a/include/qpdf/QPDFNameTreeObjectHelper.hh
+++ b/include/qpdf/QPDFNameTreeObjectHelper.hh
@@ -35,6 +35,9 @@
 // up items in the name tree, use UTF-8 strings. All names are
 // normalized for lookup purposes.
 
+// See examples/pdf-name-number-tree.cc for a demonstration of using
+// QPDFNameTreeObjectHelper.
+
 class NNTreeImpl;
 class NNTreeIterator;
 class NNTreeDetails;
diff --git a/include/qpdf/QPDFNumberTreeObjectHelper.hh b/include/qpdf/QPDFNumberTreeObjectHelper.hh
index 86b076ca..dff7ad70 100644
--- a/include/qpdf/QPDFNumberTreeObjectHelper.hh
+++ b/include/qpdf/QPDFNumberTreeObjectHelper.hh
@@ -32,6 +32,9 @@
 // This is an object helper for number trees. See section 7.9.7 in the
 // PDF spec (ISO 32000) for a description of number trees.
 
+// See examples/pdf-name-number-tree.cc for a demonstration of using
+// QPDFNumberTreeObjectHelper.
+
 class NNTreeImpl;
 class NNTreeIterator;
 class NNTreeDetails;
diff --git a/include/qpdf/QPDFObjectHandle.hh b/include/qpdf/QPDFObjectHandle.hh
index 554c7131..3f1e7d3a 100644
--- a/include/qpdf/QPDFObjectHandle.hh
+++ b/include/qpdf/QPDFObjectHandle.hh
@@ -1237,6 +1237,9 @@ class QPDFDictItems
     //     // iter.second is a QPDFObjectHandle
     // }
 
+    // See examples/pdf-name-number-tree.cc for a demonstration of
+    // using this API.
+
   public:
     QPDF_DLL
     QPDFDictItems(QPDFObjectHandle& oh);
@@ -1324,6 +1327,9 @@ class QPDFArrayItems
     //     // iter is a QPDFObjectHandle
     // }
 
+    // See examples/pdf-name-number-tree.cc for a demonstration of
+    // using this API.
+
   public:
     QPDF_DLL
     QPDFArrayItems(QPDFObjectHandle& oh);