diff options
| author | Dieter Verfaillie <dieterv@optionexplicit.be> | 2013-10-10 22:21:18 +0200 |
|---|---|---|
| committer | Colin Walters <walters@verbum.org> | 2013-10-10 16:48:51 -0400 |
| commit | a737daa16e458e87f189c2535f11f4bd2dde8f1a (patch) | |
| tree | aeafe6e33e0009a261262219f2286aab248a2ae6 /girepository/gienuminfo.c | |
| parent | 3c01854fe58c845956bc8f08e9bd9fd9929b6f8d (diff) | |
| download | gobject-introspection-a737daa16e458e87f189c2535f11f4bd2dde8f1a.tar.gz | |
docs: fix up reference docs a bit
- require GTK-Doc 1.19
- remove sgml mode
- automatically generate gi.types (needs GTK-Doc 1.19)
- fix https://bugzilla.gnome.org/show_bug.cgi?id=700025
[WIP] - rearange sections a bit
[WIP] - add gi-building, gi-programming sections
[WIP] - mark missing docs with TODO, which is only marginaly
better than nothing but at least can be grepped :)
https://bugzilla.gnome.org/show_bug.cgi?id=571648
Diffstat (limited to 'girepository/gienuminfo.c')
| -rw-r--r-- | girepository/gienuminfo.c | 25 |
1 files changed, 11 insertions, 14 deletions
diff --git a/girepository/gienuminfo.c b/girepository/gienuminfo.c index 400a56d6..253ec684 100644 --- a/girepository/gienuminfo.c +++ b/girepository/gienuminfo.c @@ -28,8 +28,8 @@ /** * SECTION:gienuminfo - * @Short_description: Structs representing an enumeration and its values - * @Title: GIEnumInfo + * @title: GIEnumInfo + * @short_description: Structs representing an enumeration and its values * * A GIEnumInfo represents an enumeration and a GIValueInfo struct represents a value * of an enumeration. The GIEnumInfo contains a set of values and a type @@ -46,13 +46,13 @@ */ /** -* g_enum_info_get_n_values: -* @info: a #GIEnumInfo -* -* Obtain the number of values this enumeration contains. -* -* Returns: the number of enumeration values -*/ + * g_enum_info_get_n_values: + * @info: a #GIEnumInfo + * + * Obtain the number of values this enumeration contains. + * + * Returns: the number of enumeration values + */ gint g_enum_info_get_n_values (GIEnumInfo *info) { @@ -76,7 +76,6 @@ g_enum_info_get_n_values (GIEnumInfo *info) * * Returns: (transfer none): the string form of the error domain associated * with this enum, or %NULL. - * * Since: 1.29.17 */ const gchar * @@ -131,7 +130,6 @@ g_enum_info_get_value (GIEnumInfo *info, * Obtain the number of methods that this enum type has. * * Returns: number of methods - * * Since: 1.29.17 */ gint @@ -157,7 +155,6 @@ g_enum_info_get_n_methods (GIEnumInfo *info) * * Returns: (transfer full): the #GIFunctionInfo. Free the struct by calling * g_base_info_unref() when done. - * * Since: 1.29.17 */ GIFunctionInfo * @@ -189,12 +186,12 @@ g_enum_info_get_method (GIEnumInfo *info, * * Obtain the tag of the type used for the enum in the C ABI. This will * will be a signed or unsigned integral type. - + * * Note that in the current implementation the width of the type is * computed correctly, but the signed or unsigned nature of the type * may not match the sign of the type used by the C compiler. * - * Return Value: the storage type for the enumeration + * Returns: the storage type for the enumeration */ GITypeTag g_enum_info_get_storage_type (GIEnumInfo *info) |