ft2font: Ensure enums are documented

QuLogic · QuLogic · commit ee46b096bc47 · 2024-09-20T05:35:09.000-04:00
And also document the version changes.
diff --git a/src/ft2font_wrapper.cpp b/src/ft2font_wrapper.cpp
@@ -23,6 +23,8 @@ const char *Kerning__doc__ = R"""(
 
     For more information, see `the FreeType documentation
     <https://freetype.org/freetype2/docs/reference/ft2-glyph_retrieval.html#ft_kerning_mode>`_.
+
+    .. versionadded: 3.10
 )""";
 
 P11X_DECLARE_ENUM(
@@ -37,6 +39,8 @@ const char *FaceFlags__doc__ = R"""(
 
     For more information, see `the FreeType documentation
     <https://freetype.org/freetype2/docs/reference/ft2-face_creation.html#ft_face_flag_xxx>`_.
+
+    .. versionadded: 3.10
 )""";
 
 enum class FaceFlags : FT_Long {
@@ -102,10 +106,12 @@ P11X_DECLARE_ENUM("FaceFlags", "enum.Flag",
 );
 
 const char *LoadFlags__doc__ = R"""(
-    Flags for `FT2Font.load_char`, `FT2font.load_glyph`, and `FT2Font.set_text`.
+    Flags for `FT2Font.load_char`, `FT2Font.load_glyph`, and `FT2Font.set_text`.
 
     For more information, see `the FreeType documentation
     <https://freetype.org/freetype2/docs/reference/ft2-glyph_retrieval.html#ft_load_xxx>`_.
+
+    .. versionadded: 3.10
 )""";
 
 enum class LoadFlags : FT_Int32 {
@@ -184,6 +190,8 @@ const char *StyleFlags__doc__ = R"""(
 
     For more information, see `the FreeType documentation
     <https://freetype.org/freetype2/docs/reference/ft2-face_creation.html#ft_style_flag_xxx>`_.
+
+    .. versionadded: 3.10
 )""";
 
 enum class StyleFlags : FT_Long {
@@ -551,6 +559,9 @@ const char *PyFT2Font_get_kerning__doc__ = R"""(
         - ``UNFITTED`` - Return scaled but un-grid-fitted kerning distances.
         - ``UNSCALED`` - Return the kerning vector in original font units.
 
+        .. versionchanged:: 3.10
+            This now takes a `.ft2font.Kerning` value instead of an `int`.
+
     Returns
     -------
     int
@@ -637,7 +648,10 @@ const char *PyFT2Font_set_text__doc__ = R"""(
     angle : float
         The angle at which to render the supplied text.
     flags : LoadFlags, default: `.LoadFlags.FORCE_AUTOHINT`
-        Any bitwise-OR combination of the `.LoadFlags` enum.
+        Any bitwise-OR combination of the `.LoadFlags` flags.
+
+        .. versionchanged:: 3.10
+            This now takes an `.ft2font.LoadFlags` instead of an int.
 
     Returns
     -------
@@ -689,7 +703,10 @@ const char *PyFT2Font_load_char__doc__ = R"""(
         The character code to prepare rendering information for. This code must be in
         the charmap, or else a ``.notdef`` glyph may be returned instead.
     flags : LoadFlags, default: `.LoadFlags.FORCE_AUTOHINT`
-        Any bitwise-OR combination of the `.LoadFlags` enum.
+        Any bitwise-OR combination of the `.LoadFlags` flags.
+
+        .. versionchanged:: 3.10
+            This now takes an `.ft2font.LoadFlags` instead of an int.
 
     Returns
     -------
@@ -737,7 +754,10 @@ const char *PyFT2Font_load_glyph__doc__ = R"""(
     glyph_index : int
         The glyph index to prepare rendering information for.
     flags : LoadFlags, default: `.LoadFlags.FORCE_AUTOHINT`
-        Any bitwise-OR combination of the `.LoadFlags` enum.
+        Any bitwise-OR combination of the `.LoadFlags` flags.
+
+        .. versionchanged:: 3.10
+            This now takes an `.ft2font.LoadFlags` instead of an int.
 
     Returns
     -------
@@ -1590,6 +1610,10 @@ PYBIND11_MODULE(ft2font, m)
     snprintf(version_string, sizeof(version_string), "%d.%d.%d", major, minor, patch);
 
     p11x::bind_enums(m);
+    p11x::enums["Kerning"].attr("__doc__") = Kerning__doc__;
+    p11x::enums["LoadFlags"].attr("__doc__") = LoadFlags__doc__;
+    p11x::enums["FaceFlags"].attr("__doc__") = FaceFlags__doc__;
+    p11x::enums["StyleFlags"].attr("__doc__") = StyleFlags__doc__;
 
     py::class_<FT2Image>(m, "FT2Image", py::is_final(), py::buffer_protocol(),
                          PyFT2Image__doc__)
