luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-01-13 07:56:17 +01:00
Code Issues Packages Projects Releases Wiki Activity

GObject: Introspection annotations for enums

Browse Source 
This commit adds a few missing annotations to g_enum and
g_flags functions.

https://bugzilla.gnome.org/show_bug.cgi?id=708274
This commit is contained in:
Gergely POLONKAI 2013-09-18 11:01:00 +00:00 committed by Matthias Clasen
parent aef0adc0dd
commit 047d9ce6f2
1 changed files with 16 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
gobject/genums.c
View File

@ -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,