From 4b674b42e4c1b9b470dd4ca8b84ac4db1d430055 Mon Sep 17 00:00:00 2001 From: Jay Berkenbilt Date: Wed, 21 Aug 2019 13:05:06 -0400 Subject: [PATCH] Mention name tokens in TokenFilter comments --- include/qpdf/QPDFObjectHandle.hh | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/include/qpdf/QPDFObjectHandle.hh b/include/qpdf/QPDFObjectHandle.hh index 1b0d481b..0569ec5d 100644 --- a/include/qpdf/QPDFObjectHandle.hh +++ b/include/qpdf/QPDFObjectHandle.hh @@ -98,7 +98,13 @@ class QPDFObjectHandle // for being written to output, or calling writeToken with a // string token will also work. The correct way to construct a // string token that would write the literal value (str) is - // QPDFTokenizer::Token(QPDFTokenizer::tt_string, "str"). + // QPDFTokenizer::Token(QPDFTokenizer::tt_string, "str"). A + // similar situation exists with tt_name. token.getValue() returns + // a normalized name with # codes resolved into characters, and + // may not be suitable for writing. You can pass it to + // QPDF_Name::normalizeName first, or you can use writeToken with + // a name token. The correct way to create a name token is + // QPDFTokenizer::Token(QPDFTokenizer::tt_name, "/Name"). class QPDF_DLL_CLASS TokenFilter { public: