Major rework of handling form fields when copying pages (fixes #509)

1 files changed, 8 insertions, 2 deletions

diff --git a/include/qpdf/QPDFFormFieldObjectHelper.hh b/include/qpdf/QPDFFormFieldObjectHelper.hh
index 6052f2e3..4085371e 100644
--- a/include/qpdf/QPDFFormFieldObjectHelper.hh
+++ b/include/qpdf/QPDFFormFieldObjectHelper.hh
@@ -172,12 +172,18 @@ class QPDFFormFieldObjectHelper: public QPDFObjectHelper
     QPDF_DLL
     std::vector<std::string> getChoices();
 
-    // Set an attribute to the given value
+    // Set an attribute to the given value. If you have a
+    // QPDFAcroFormDocumentHelper and you want to set the name of a
+    // field, use QPDFAcroFormDocumentHelper::setFormFieldName
+    // instead.
     QPDF_DLL
     void setFieldAttribute(std::string const& key, QPDFObjectHandle value);
 
     // Set an attribute to the given value as a Unicode string (UTF-16
-    // BE encoded). The input string should be UTF-8 encoded.
+    // BE encoded). The input string should be UTF-8 encoded. If you
+    // have a QPDFAcroFormDocumentHelper and you want to set the name
+    // of a field, use QPDFAcroFormDocumentHelper::setFormFieldName
+    // instead.
     QPDF_DLL
     void setFieldAttribute(std::string const& key,
                            std::string const& utf8_value);