summaryrefslogtreecommitdiff
path: root/build-aux/templates/mm-enums-types.h.template
diff options
context:
space:
mode:
authorAleksander Morgado <aleksandermj@chromium.org>2023-04-27 12:19:18 +0000
committerAleksander Morgado <aleksander@aleksander.es>2023-04-27 12:23:04 +0000
commitbf2843ad77732f5fbe1ee04e7ad5415a60bf5eeb (patch)
treed9be783f8a8e239652ea7837700d98dc6359765f /build-aux/templates/mm-enums-types.h.template
parentfdf03f9b2ccbc4a6a0a8102d44a991f78673e5a1 (diff)
downloadModemManager-bf2843ad77732f5fbe1ee04e7ad5415a60bf5eeb.tar.gz
libmm-glib: separate files for flags and enums types
This allows us to skip needing to include the non-existent build_string_from_mask() or get_string() counterparts in the documentation index.
Diffstat (limited to 'build-aux/templates/mm-enums-types.h.template')
-rw-r--r--build-aux/templates/mm-enums-types.h.template19
1 files changed, 8 insertions, 11 deletions
diff --git a/build-aux/templates/mm-enums-types.h.template b/build-aux/templates/mm-enums-types.h.template
index 24d18a9dc..4c99eb9f9 100644
--- a/build-aux/templates/mm-enums-types.h.template
+++ b/build-aux/templates/mm-enums-types.h.template
@@ -14,18 +14,15 @@ G_BEGIN_DECLS
GType @enum_name@_get_type (void) G_GNUC_CONST;
#define @ENUMPREFIX@_TYPE_@ENUMSHORT@ (@enum_name@_get_type ())
-/* Define type-specific symbols */
-#undef __MM_IS_ENUM__
-#undef __MM_IS_FLAGS__
-#define __MM_IS_@TYPE@__
-
-#if defined __MM_IS_ENUM__
+/**
+ * @enum_name@_get_string:
+ * @val: a @EnumName@.
+ *
+ * Gets the nickname string for the #@EnumName@ specified at @val.
+ *
+ * Returns: (transfer none): a string with the nickname, or %NULL if not found. Do not free the returned value.
+ */
const gchar *@enum_name@_get_string (@EnumName@ val);
-#endif
-
-#if defined __MM_IS_FLAGS__
-gchar *@enum_name@_build_string_from_mask (@EnumName@ mask);
-#endif
/*** END value-header ***/