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

Fix documentation for return values.

Browse Source 
* gobject/genums.h:
	  Fix documentation for return values.


svn path=/trunk/; revision=7070
This commit is contained in:
Stefan Kost 2008-06-21 12:24:56 +00:00
parent 83dd545044
commit 2ff70abe68
2 changed files with 24 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
ChangeLog
View File

@ -1,3 +1,8 @@
2008-06-21 Stefan Kost <ensonic@users.sf.net>
* gobject/genums.h:
Fix documentation for return values.
2008-06-21 Stefan Kost <ensonic@users.sf.net> 2008-06-21 Stefan Kost <ensonic@users.sf.net>
* docs/reference/gobject/tmpl/gclosure.sgml: * docs/reference/gobject/tmpl/gclosure.sgml:

24
gobject/genums.h
View File

@ -32,7 +32,9 @@ G_BEGIN_DECLS
* G_TYPE_IS_ENUM: * G_TYPE_IS_ENUM:
* @type: a #GType ID. * @type: a #GType ID.
* *
* Returns: whether @type "is a" %G_TYPE_ENUM. * Checks whether @type "is a" %G_TYPE_ENUM.
*
* Returns: %TRUE if @type "is a" %G_TYPE_ENUM.
*/ */
#define G_TYPE_IS_ENUM(type) (G_TYPE_FUNDAMENTAL (type) == G_TYPE_ENUM) #define G_TYPE_IS_ENUM(type) (G_TYPE_FUNDAMENTAL (type) == G_TYPE_ENUM)
/** /**
@ -54,14 +56,18 @@ G_BEGIN_DECLS
* G_ENUM_CLASS_TYPE: * G_ENUM_CLASS_TYPE:
* @class: a #GEnumClass * @class: a #GEnumClass
* *
* Returns: the type identifier from a given #GEnumClass structure. * Get the type identifier from a given #GEnumClass structure.
*
* Returns: the #GType
*/ */
#define G_ENUM_CLASS_TYPE(class) (G_TYPE_FROM_CLASS (class)) #define G_ENUM_CLASS_TYPE(class) (G_TYPE_FROM_CLASS (class))
/** /**
* G_ENUM_CLASS_TYPE_NAME: * G_ENUM_CLASS_TYPE_NAME:
* @class: a #GEnumClass * @class: a #GEnumClass
* *
* Returns: the static type name from a given #GEnumClass structure. * Get the static type name from a given #GEnumClass structure.
*
* Returns: the type name.
*/ */
#define G_ENUM_CLASS_TYPE_NAME(class) (g_type_name (G_ENUM_CLASS_TYPE (class))) #define G_ENUM_CLASS_TYPE_NAME(class) (g_type_name (G_ENUM_CLASS_TYPE (class)))
@ -70,7 +76,9 @@ G_BEGIN_DECLS
* G_TYPE_IS_FLAGS: * G_TYPE_IS_FLAGS:
* @type: a #GType ID. * @type: a #GType ID.
* *
* Returns: whether @type "is a" %G_TYPE_FLAGS. * Checks whether @type "is a" %G_TYPE_FLAGS.
*
* Returns: %TRUE if @type "is a" %G_TYPE_FLAGS.
*/ */
#define G_TYPE_IS_FLAGS(type) (G_TYPE_FUNDAMENTAL (type) == G_TYPE_FLAGS) #define G_TYPE_IS_FLAGS(type) (G_TYPE_FUNDAMENTAL (type) == G_TYPE_FLAGS)
/** /**
@ -92,14 +100,18 @@ G_BEGIN_DECLS
* G_FLAGS_CLASS_TYPE: * G_FLAGS_CLASS_TYPE:
* @class: a #GFlagsClass * @class: a #GFlagsClass
* *
* Returns: the type identifier from a given #GFlagsClass structure. * Get the type identifier from a given #GFlagsClass structure.
*
* Returns: the #GType
*/ */
#define G_FLAGS_CLASS_TYPE(class) (G_TYPE_FROM_CLASS (class)) #define G_FLAGS_CLASS_TYPE(class) (G_TYPE_FROM_CLASS (class))
/** /**
* G_FLAGS_CLASS_TYPE_NAME: * G_FLAGS_CLASS_TYPE_NAME:
* @class: a #GFlagsClass * @class: a #GFlagsClass
* *
* Returns: the static type name from a given #GFlagsClass structure. * Get the static type name from a given #GFlagsClass structure.
*
* Returns: the type name.
*/ */
#define G_FLAGS_CLASS_TYPE_NAME(class) (g_type_name (G_FLAGS_CLASS_TYPE (class))) #define G_FLAGS_CLASS_TYPE_NAME(class) (g_type_name (G_FLAGS_CLASS_TYPE (class)))