OpenSystemsDevelopment / qpdf

Commit 8a5ba5686c8cd6f3a9bd65e58ef001e1ae4f15b8

Authored by m-holger
Committed by Jay Berkenbilt
1 parent 0f9086e5

Add some doc comments for QPDFObjectHandle dictionary methods

Inline Side-by-side
Showing 1 changed file with 7 additions and 0 deletions
include/qpdf/QPDFObjectHandle.hh
  View file @8a5ba56
@@ -777,12 +777,19 @@ class QPDFObjectHandle @@ -777,12 +777,19 @@ class QPDFObjectHandle
777 QPDF_DLL 777 QPDF_DLL
778 QPDFDictItems ditems(); 778 QPDFDictItems ditems();
779 779
  780 + // Return true if key is present. Keys with null values are treated as if
  781 + // they are not present. This is as per the PDF spec.
780 QPDF_DLL 782 QPDF_DLL
781 bool hasKey(std::string const&); 783 bool hasKey(std::string const&);
  784 + // Return the value for the key. If the key is not present, null is
  785 + // returned.
782 QPDF_DLL 786 QPDF_DLL
783 QPDFObjectHandle getKey(std::string const&); 787 QPDFObjectHandle getKey(std::string const&);
  788 + // Return all keys. Keys with null values are treated as if
  789 + // they are not present. This is as per the PDF spec.
784 QPDF_DLL 790 QPDF_DLL
785 std::set<std::string> getKeys(); 791 std::set<std::string> getKeys();
  792 + // Return dictionary as a map. Entries with null values are included.
786 QPDF_DLL 793 QPDF_DLL
787 std::map<std::string, QPDFObjectHandle> getDictAsMap(); 794 std::map<std::string, QPDFObjectHandle> getDictAsMap();
788 795