From 8a5ba5686c8cd6f3a9bd65e58ef001e1ae4f15b8 Mon Sep 17 00:00:00 2001 From: m-holger Date: Sun, 30 Jan 2022 14:39:01 +0000 Subject: Add some doc comments for QPDFObjectHandle dictionary methods --- include/qpdf/QPDFObjectHandle.hh | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'include') diff --git a/include/qpdf/QPDFObjectHandle.hh b/include/qpdf/QPDFObjectHandle.hh index ac6b4b55..7f3154c6 100644 --- a/include/qpdf/QPDFObjectHandle.hh +++ b/include/qpdf/QPDFObjectHandle.hh @@ -777,12 +777,19 @@ class QPDFObjectHandle QPDF_DLL QPDFDictItems ditems(); + // Return true if key is present. Keys with null values are treated as if + // they are not present. This is as per the PDF spec. QPDF_DLL bool hasKey(std::string const&); + // Return the value for the key. If the key is not present, null is + // returned. QPDF_DLL QPDFObjectHandle getKey(std::string const&); + // Return all keys. Keys with null values are treated as if + // they are not present. This is as per the PDF spec. QPDF_DLL std::set getKeys(); + // Return dictionary as a map. Entries with null values are included. QPDF_DLL std::map getDictAsMap(); -- cgit v1.2.3-54-g00ecf