aboutsummaryrefslogtreecommitdiffstats
path: root/build-aux/templates/qmi-enum-types-template.h
diff options
context:
space:
mode:
Diffstat (limited to 'build-aux/templates/qmi-enum-types-template.h')
-rw-r--r--build-aux/templates/qmi-enum-types-template.h17
1 files changed, 17 insertions, 0 deletions
diff --git a/build-aux/templates/qmi-enum-types-template.h b/build-aux/templates/qmi-enum-types-template.h
index 31e0732..3457e9b 100644
--- a/build-aux/templates/qmi-enum-types-template.h
+++ b/build-aux/templates/qmi-enum-types-template.h
@@ -18,10 +18,27 @@ GType @enum_name@_get_type (void) G_GNUC_CONST;
#define __@ENUMNAME@_IS_@TYPE@__
#if defined __@ENUMNAME@_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 __@ENUMNAME@_IS_FLAGS__
+/**
+ * @enum_name@_build_string_from_mask:
+ * @mask: bitmask of @EnumName@ values.
+ *
+ * Builds a string containing a comma-separated list of nicknames for
+ * each #@EnumName@ in @mask.
+ *
+ * Returns: (transfer full): a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free().
+ */
gchar *@enum_name@_build_string_from_mask (@EnumName@ mask);
#endif