docs: update enums, flags and errors documentation

5 files changed, 35 insertions, 26 deletions

diff --git a/build-aux/templates/qmi-enum-types-template.c b/build-aux/templates/qmi-enum-types-template.c
index 635147f..a5c134d 100644
--- a/build-aux/templates/qmi-enum-types-template.c
+++ b/build-aux/templates/qmi-enum-types-template.c
@@ -37,14 +37,6 @@ GType
  * We get the nick of the GEnumValue. Note that this will be
  * valid even if the GEnumClass is not referenced anywhere. */
 #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)
 {
@@ -64,15 +56,6 @@ const gchar *
  * Note that this will be valid even if the GFlagsClass is not referenced
  * anywhere. */
 #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)
 {
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
 
diff --git a/build-aux/templates/qmi-error-types-template.h b/build-aux/templates/qmi-error-types-template.h
index 217f006..b0dfdb2 100644
--- a/build-aux/templates/qmi-error-types-template.h
+++ b/build-aux/templates/qmi-error-types-template.h
@@ -15,6 +15,15 @@ GQuark @enum_name@_quark    (void);
 GType  @enum_name@_get_type (void) G_GNUC_CONST;
 #define @ENUMNAME@ (@enum_name@_quark ())
 #define @ENUMPREFIX@_TYPE_@ENUMSHORT@ (@enum_name@_get_type ())
+
+/**
+ * @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);
 /*** END value-header ***/
 
diff --git a/build-aux/templates/qmi-flags64-types-template.c b/build-aux/templates/qmi-flags64-types-template.c
index a92824c..61d541c 100644
--- a/build-aux/templates/qmi-flags64-types-template.c
+++ b/build-aux/templates/qmi-flags64-types-template.c
@@ -22,15 +22,6 @@ static const GFlags64Value @enum_name@_values[] = {
     { 0, NULL, NULL }
 };
 
-/**
- * @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)
 {
diff --git a/build-aux/templates/qmi-flags64-types-template.h b/build-aux/templates/qmi-flags64-types-template.h
index 981d0e1..f471c29 100644
--- a/build-aux/templates/qmi-flags64-types-template.h
+++ b/build-aux/templates/qmi-flags64-types-template.h
@@ -18,6 +18,15 @@ G_BEGIN_DECLS
 #error Only flags expected, @EnumName@ is an enumeration
 #endif
 
+/**
+ * @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);
 
 /*** END value-header ***/