[glib] GObject: Introspection annotations for enums
- From: Matthias Clasen <matthiasc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glib] GObject: Introspection annotations for enums
- Date: Sat, 23 Nov 2013 18:38:09 +0000 (UTC)
commit 047d9ce6f2ae840bacb3e4cf42d128d9d247b96e
Author: Gergely POLONKAI <gergely polonkai eu>
Date: Wed Sep 18 11:01:00 2013 +0000
GObject: Introspection annotations for enums
This commit adds a few missing annotations to g_enum and
g_flags functions.
https://bugzilla.gnome.org/show_bug.cgi?id=708274
gobject/genums.c | 30 ++++++++++++++++--------------
1 files changed, 16 insertions(+), 14 deletions(-)
---
diff --git a/gobject/genums.c b/gobject/genums.c
index 474e791..81c1893 100644
--- a/gobject/genums.c
+++ b/gobject/genums.c
@@ -255,7 +255,7 @@ g_flags_register_static (const gchar *name,
/**
* g_enum_complete_type_info:
* @g_enum_type: the type identifier of the type being completed
- * @info: the #GTypeInfo struct to be filled in
+ * @info: (out callee-allocates): the #GTypeInfo struct to be filled in
* @const_values: An array of #GEnumValue structs for the possible
* enumeration values. The array is terminated by a struct with all
* members being 0.
@@ -301,7 +301,7 @@ g_enum_complete_type_info (GType g_enum_type,
/**
* g_flags_complete_type_info:
* @g_flags_type: the type identifier of the type being completed
- * @info: the #GTypeInfo struct to be filled in
+ * @info: (out callee-allocates): the #GTypeInfo struct to be filled in
* @const_values: An array of #GFlagsValue structs for the possible
* enumeration values. The array is terminated by a struct with all
* members being 0.
@@ -382,8 +382,9 @@ g_flags_class_init (GFlagsClass *class,
*
* Looks up a #GEnumValue by name.
*
- * Returns: the #GEnumValue with name @name, or %NULL if the
- * enumeration doesn't have a member with that name
+ * Returns: (transfer none): the #GEnumValue with name @name,
+ * or %NULL if the enumeration doesn't have a member
+ * with that name
*/
GEnumValue*
g_enum_get_value_by_name (GEnumClass *enum_class,
@@ -411,8 +412,8 @@ g_enum_get_value_by_name (GEnumClass *enum_class,
*
* Looks up a #GFlagsValue by name.
*
- * Returns: the #GFlagsValue with name @name, or %NULL if there is no
- * flag with that name
+ * Returns: (transfer none): the #GFlagsValue with name @name,
+ * or %NULL if there is no flag with that name
*/
GFlagsValue*
g_flags_get_value_by_name (GFlagsClass *flags_class,
@@ -440,8 +441,9 @@ g_flags_get_value_by_name (GFlagsClass *flags_class,
*
* Looks up a #GEnumValue by nickname.
*
- * Returns: the #GEnumValue with nickname @nick, or %NULL if the
- * enumeration doesn't have a member with that nickname
+ * Returns: (transfer none): the #GEnumValue with nickname @nick,
+ * or %NULL if the enumeration doesn't have a member
+ * with that nickname
*/
GEnumValue*
g_enum_get_value_by_nick (GEnumClass *enum_class,
@@ -469,8 +471,8 @@ g_enum_get_value_by_nick (GEnumClass *enum_class,
*
* Looks up a #GFlagsValue by nickname.
*
- * Returns: the #GFlagsValue with nickname @nick, or %NULL if there is
- * no flag with that nickname
+ * Returns: (transfer none): the #GFlagsValue with nickname @nick,
+ * or %NULL if there is no flag with that nickname
*/
GFlagsValue*
g_flags_get_value_by_nick (GFlagsClass *flags_class,
@@ -498,8 +500,8 @@ g_flags_get_value_by_nick (GFlagsClass *flags_class,
*
* Returns the #GEnumValue for a value.
*
- * Returns: the #GEnumValue for @value, or %NULL if @value is not a
- * member of the enumeration
+ * Returns: (transfer none): the #GEnumValue for @value, or %NULL
+ * if @value is not a member of the enumeration
*/
GEnumValue*
g_enum_get_value (GEnumClass *enum_class,
@@ -526,8 +528,8 @@ g_enum_get_value (GEnumClass *enum_class,
*
* Returns the first #GFlagsValue which is set in @value.
*
- * Returns: the first #GFlagsValue which is set in @value, or %NULL if
- * none is set
+ * Returns: (transfer none): the first #GFlagsValue which is set in
+ * @value, or %NULL if none is set
*/
GFlagsValue*
g_flags_get_first_value (GFlagsClass *flags_class,
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]