luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-01-11 23:16:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add docs.

Browse Source 
* gobject/tmpl/enumerations_flags.sgml:
	* gobject/tmpl/gclosure.sgml:
	* gobject/tmpl/param_value_types.sgml: Add docs.
This commit is contained in:
Matthias Clasen 2002-12-08 23:16:50 +00:00
parent 0357db56f8
commit b9da696ea0
4 changed files with 66 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/reference/ChangeLog
View File

@ -1,3 +1,9 @@
2002-12-09 Matthias Clasen <maclas@gmx.de>
* gobject/tmpl/enumerations_flags.sgml:
* gobject/tmpl/gclosure.sgml:
* gobject/tmpl/param_value_types.sgml: Add docs.
2002-12-06 Matthias Clasen <maclas@gmx.de>
* gobject/tmpl/gparamspec.sgml: Typo fix.

17
docs/reference/gobject/tmpl/enumerations_flags.sgml
View File

@ -18,12 +18,21 @@ Enumeration and flags types
</para>
@g_type_class:
@minimum:
@maximum:
@n_values:
@values:
<!-- ##### STRUCT GFlagsClass ##### -->
<para>
</para>
@g_type_class:
@mask:
@n_values:
@values:
<!-- ##### MACRO G_ENUM_CLASS_TYPE ##### -->
<para>
@ -43,10 +52,10 @@ Enumeration and flags types
<!-- ##### MACRO G_TYPE_IS_ENUM ##### -->
<para>
Returns whether @type "is a" %G_TYPE_ENUM.
</para>
@type:
@type: a #GType ID.
<!-- ##### MACRO G_ENUM_CLASS ##### -->
@ -67,10 +76,10 @@ Enumeration and flags types
<!-- ##### MACRO G_TYPE_IS_FLAGS ##### -->
<para>
Returns whether @type "is a" %G_TYPE_FLAGS.
</para>
@type:
@type: a #GType ID.
<!-- ##### MACRO G_FLAGS_CLASS ##### -->

6
docs/reference/gobject/tmpl/gclosure.sgml
View File

@ -63,7 +63,7 @@ Functions as first-class objects
<!-- ##### MACRO G_TYPE_CLOSURE ##### -->
<para>
The #GType for #GClosure.
</para>
@ -328,14 +328,14 @@ atfer this function, unles g_closure_ref() was called beforehand.
<!-- ##### MACRO G_TYPE_IO_CHANNEL ##### -->
<para>
The #GType for #GIOChannel.
</para>
<!-- ##### MACRO G_TYPE_IO_CONDITION ##### -->
<para>
The #GType for #GIOCondition.
</para>

88
docs/reference/gobject/tmpl/param_value_types.sgml
View File

@ -45,7 +45,7 @@ Return whether the given #GValue can hold values of type %G_TYPE_BOOLEAN.
<!-- ##### MACRO G_TYPE_PARAM_BOOLEAN ##### -->
<para>
The #GType of #GParamSpecBoolean.
</para>
@ -115,7 +115,7 @@ Return whether the given #GValue can hold values of type %G_TYPE_CHAR.
<!-- ##### MACRO G_TYPE_PARAM_CHAR ##### -->
<para>
The #GType of #GParamSpecChar.
</para>
@ -189,7 +189,7 @@ Return whether the given #GValue can hold values of type %G_TYPE_UCHAR.
<!-- ##### MACRO G_TYPE_PARAM_UCHAR ##### -->
<para>
The #GType of #GParamSpecUChar.
</para>
@ -263,7 +263,7 @@ Return whether the given #GValue can hold values of type %G_TYPE_INT.
<!-- ##### MACRO G_TYPE_PARAM_INT ##### -->
<para>
The #GType of #GParamSpecInt.
</para>
@ -337,7 +337,7 @@ Return whether the given #GValue can hold values of type %G_TYPE_UINT.
<!-- ##### MACRO G_TYPE_PARAM_UINT ##### -->
<para>
The #GType of #GParamSpecUInt.
</para>
@ -411,7 +411,7 @@ Return whether the given #GValue can hold values of type %G_TYPE_LONG.
<!-- ##### MACRO G_TYPE_PARAM_LONG ##### -->
<para>
The #GType of #GParamSpecLong.
</para>
@ -485,7 +485,7 @@ Return whether the given #GValue can hold values of type %G_TYPE_ULONG.
<!-- ##### MACRO G_TYPE_PARAM_ULONG ##### -->
<para>
The #GType of #GParamSpecULong.
</para>
@ -559,7 +559,7 @@ Return whether the given #GValue can hold values of type %G_TYPE_INT64.
<!-- ##### MACRO G_TYPE_PARAM_INT64 ##### -->
<para>
The #GType of #GParamSpecInt64.
</para>
@ -633,7 +633,7 @@ Return whether the given #GValue can hold values of type %G_TYPE_UINT64.
<!-- ##### MACRO G_TYPE_PARAM_UINT64 ##### -->
<para>
The #GType of #GParamSpecUInt64.
</para>
@ -707,7 +707,7 @@ Return whether the given #GValue can hold values of type %G_TYPE_FLOAT.
<!-- ##### MACRO G_TYPE_PARAM_FLOAT ##### -->
<para>
The #GType of #GParamSpecFloat.
</para>
@ -782,7 +782,7 @@ Return whether the given #GValue can hold values of type %G_TYPE_DOUBLE.
<!-- ##### MACRO G_TYPE_PARAM_DOUBLE ##### -->
<para>
The #GType of #GParamSpecDouble.
</para>
@ -833,18 +833,18 @@ Get the contents of a %G_TYPE_DOUBLE #GValue.
<!-- ##### MACRO G_IS_PARAM_SPEC_ENUM ##### -->
<para>
Returns whether the given #GParamSpec is of type %G_TYPE_PARAM_ENUM.
</para>
@pspec:
@pspec: a valid #GParamSpec instance
<!-- ##### MACRO G_PARAM_SPEC_ENUM ##### -->
<para>
Cast a #GParamSpec instance into a #GParamSpecEnum.
</para>
@pspec:
@pspec: a valid #GParamSpec instance
<!-- ##### MACRO G_VALUE_HOLDS_ENUM ##### -->
@ -857,7 +857,7 @@ Get the contents of a %G_TYPE_DOUBLE #GValue.
<!-- ##### MACRO G_TYPE_PARAM_ENUM ##### -->
<para>
The #GType of #GParamSpecEnum.
</para>
@ -905,18 +905,18 @@ Get the contents of a %G_TYPE_DOUBLE #GValue.
<!-- ##### MACRO G_IS_PARAM_SPEC_FLAGS ##### -->
<para>
Returns whether the given #GParamSpec is of type %G_TYPE_PARAM_FLAGS.
</para>
@pspec:
@pspec: a valid #GParamSpec instance
<!-- ##### MACRO G_PARAM_SPEC_FLAGS ##### -->
<para>
Cast a #GParamSpec instance into a #GParamSpecChar.
</para>
@pspec:
@pspec: a valid #GParamSpec instance
<!-- ##### MACRO G_VALUE_HOLDS_FLAGS ##### -->
@ -929,7 +929,7 @@ Get the contents of a %G_TYPE_DOUBLE #GValue.
<!-- ##### MACRO G_TYPE_PARAM_FLAGS ##### -->
<para>
The #GType of #GParamSpecFlags.
</para>
@ -977,18 +977,18 @@ Get the contents of a %G_TYPE_DOUBLE #GValue.
<!-- ##### MACRO G_IS_PARAM_SPEC_STRING ##### -->
<para>
Returns whether the given #GParamSpec is of type %G_TYPE_PARAM_STRING.
</para>
@pspec:
@pspec: a valid #GParamSpec instance
<!-- ##### MACRO G_PARAM_SPEC_STRING ##### -->
<para>
Casts a #GParamSpec instance into a #GParamSpecString.
</para>
@pspec:
@pspec: a valid #GParamSpec instance
<!-- ##### MACRO G_VALUE_HOLDS_STRING ##### -->
@ -1001,7 +1001,7 @@ Get the contents of a %G_TYPE_DOUBLE #GValue.
<!-- ##### MACRO G_TYPE_PARAM_STRING ##### -->
<para>
The #GType of #GParamSpecString.
</para>
@ -1085,18 +1085,18 @@ Get the contents of a %G_TYPE_DOUBLE #GValue.
<!-- ##### MACRO G_IS_PARAM_SPEC_PARAM ##### -->
<para>
Returns whether the given #GParamSpec is of type %G_TYPE_PARAM_PARAM.
</para>
@pspec:
@pspec: a valid #GParamSpec instance
<!-- ##### MACRO G_PARAM_SPEC_PARAM ##### -->
<para>
Casts a #GParamSpec instance into a #GParamSpecParam.
</para>
@pspec:
@pspec: a valid #GParamSpec instance
<!-- ##### MACRO G_VALUE_HOLDS_PARAM ##### -->
@ -1109,7 +1109,7 @@ Get the contents of a %G_TYPE_DOUBLE #GValue.
<!-- ##### MACRO G_TYPE_PARAM_PARAM ##### -->
<para>
The #GType of #GParamSpecParam.
</para>
@ -1196,7 +1196,7 @@ Return whether the given #GValue can hold values derived from type %G_TYPE_BOXED
<!-- ##### MACRO G_TYPE_PARAM_BOXED ##### -->
<para>
The #GType of #GParamSpecBoxed.
</para>
@ -1272,18 +1272,18 @@ later freed with g_boxed_free(), e.g. like: g_boxed_free (G_VALUE_TYPE (@value),
<!-- ##### MACRO G_IS_PARAM_SPEC_POINTER ##### -->
<para>
Returns whether the given #GParamSpec is of type %G_TYPE_PARAM_POINTER.
</para>
@pspec:
@pspec: a valid #GParamSpec instance
<!-- ##### MACRO G_PARAM_SPEC_POINTER ##### -->
<para>
Casts a #GParamSpec instance into a #GParamSpecPointer.
</para>
@pspec:
@pspec: a valid #GParamSpec instance
<!-- ##### MACRO G_VALUE_HOLDS_POINTER ##### -->
@ -1296,7 +1296,7 @@ later freed with g_boxed_free(), e.g. like: g_boxed_free (G_VALUE_TYPE (@value),
<!-- ##### MACRO G_TYPE_PARAM_POINTER ##### -->
<para>
The #GType of #GParamSpecPointer.
</para>
@ -1340,18 +1340,18 @@ later freed with g_boxed_free(), e.g. like: g_boxed_free (G_VALUE_TYPE (@value),
<!-- ##### MACRO G_IS_PARAM_SPEC_OBJECT ##### -->
<para>
Returns whether the given #GParamSpec is of type %G_TYPE_PARAM_OBJECT.
</para>
@pspec:
@pspec: a valid #GParamSpec instance
<!-- ##### MACRO G_PARAM_SPEC_OBJECT ##### -->
<para>
Casts a #GParamSpec instance into a #GParamSpecObject.
</para>
@pspec:
@pspec: a valid #GParamSpec instance
<!-- ##### MACRO G_VALUE_HOLDS_OBJECT ##### -->
@ -1364,7 +1364,7 @@ later freed with g_boxed_free(), e.g. like: g_boxed_free (G_VALUE_TYPE (@value),
<!-- ##### MACRO G_TYPE_PARAM_OBJECT ##### -->
<para>
The #GType of #GParamSpecObject.
</para>
@ -1443,7 +1443,7 @@ Cast a #GParamSpec instance into a #GParamSpecUnichar.
<!-- ##### MACRO G_TYPE_PARAM_UNICHAR ##### -->
<para>
The #GType of #GParamSpecUnichar.
</para>
@ -1489,7 +1489,7 @@ Cast a #GParamSpec instance into a #GParamSpecValueArray.
<!-- ##### MACRO G_TYPE_PARAM_VALUE_ARRAY ##### -->
<para>
The #GType of #GParamSpecValueArray.
</para>