Remove QPDFObject::object_type_e as alias for qpdf_object_type_e

1 files changed, 12 insertions, 0 deletions

diff --git a/manual/release-notes.rst b/manual/release-notes.rst
index 49298836..e3e65d88 100644
--- a/manual/release-notes.rst
+++ b/manual/release-notes.rst
@@ -95,6 +95,18 @@ For a detailed list of changes, please see the file
 
   - API: breaking changes
 
+    - Remove ``QPDFObject.hh`` from the public ``include/qpdf``
+      directory. The only use case for including
+      ``qpdf/QPDFObject.hh`` was to get ``QPDFObject::object_type_e``.
+      Since 10.5.0, this has been an alias to ``qpdf_object_type_e``,
+      defined in ``qpdf/Constants.h``. To fix your code, replace any
+      includes of ``qpdf/QPDFObject.hh`` with ``qpdf/Constants.h``,
+      and replace all occurrences of ``QPDFObject::ot_`` with
+      ``::ot_``. If you need your code to be backward compatible to
+      qpdf versions prior to 10.5.0, you can check that the
+      preprocessor symbol ``QPDF_MAJOR_VERSION`` is defined and ``>=
+      11``.
+
     - Pipeline::write now takes ``unsigned char const*`` instead of
       ``unsigned char*``. Callers don't need to change anything, but
       you no longer have to pass writable pointers to pipelines. If