mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2024-12-25 15:06:14 +01:00
Fix documentation for return values.
* gobject/genums.h: Fix documentation for return values. svn path=/trunk/; revision=7070
This commit is contained in:
parent
83dd545044
commit
2ff70abe68
@ -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>
|
||||
|
||||
* docs/reference/gobject/tmpl/gclosure.sgml:
|
||||
|
@ -32,7 +32,9 @@ G_BEGIN_DECLS
|
||||
* G_TYPE_IS_ENUM:
|
||||
* @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)
|
||||
/**
|
||||
@ -54,14 +56,18 @@ G_BEGIN_DECLS
|
||||
* G_ENUM_CLASS_TYPE:
|
||||
* @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))
|
||||
/**
|
||||
* G_ENUM_CLASS_TYPE_NAME:
|
||||
* @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)))
|
||||
|
||||
@ -69,8 +75,10 @@ G_BEGIN_DECLS
|
||||
/**
|
||||
* G_TYPE_IS_FLAGS:
|
||||
* @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)
|
||||
/**
|
||||
@ -92,14 +100,18 @@ G_BEGIN_DECLS
|
||||
* G_FLAGS_CLASS_TYPE:
|
||||
* @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))
|
||||
/**
|
||||
* G_FLAGS_CLASS_TYPE_NAME:
|
||||
* @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)))
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user