From b9da696ea0ff0c3ba31b5c7ea56481e62c6f6f9c Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Sun, 8 Dec 2002 23:16:50 +0000 Subject: [PATCH] Add docs. * gobject/tmpl/enumerations_flags.sgml: * gobject/tmpl/gclosure.sgml: * gobject/tmpl/param_value_types.sgml: Add docs. --- docs/reference/ChangeLog | 6 ++ .../gobject/tmpl/enumerations_flags.sgml | 17 +++- docs/reference/gobject/tmpl/gclosure.sgml | 6 +- .../gobject/tmpl/param_value_types.sgml | 88 +++++++++---------- 4 files changed, 66 insertions(+), 51 deletions(-) diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index 81300a502..ece0cb05b 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,9 @@ +2002-12-09 Matthias Clasen + + * gobject/tmpl/enumerations_flags.sgml: + * gobject/tmpl/gclosure.sgml: + * gobject/tmpl/param_value_types.sgml: Add docs. + 2002-12-06 Matthias Clasen * gobject/tmpl/gparamspec.sgml: Typo fix. diff --git a/docs/reference/gobject/tmpl/enumerations_flags.sgml b/docs/reference/gobject/tmpl/enumerations_flags.sgml index 3a170eecb..cfc19dd72 100644 --- a/docs/reference/gobject/tmpl/enumerations_flags.sgml +++ b/docs/reference/gobject/tmpl/enumerations_flags.sgml @@ -18,12 +18,21 @@ Enumeration and flags types +@g_type_class: +@minimum: +@maximum: +@n_values: +@values: +@g_type_class: +@mask: +@n_values: +@values: @@ -43,10 +52,10 @@ Enumeration and flags types - +Returns whether @type "is a" %G_TYPE_ENUM. -@type: +@type: a #GType ID. @@ -67,10 +76,10 @@ Enumeration and flags types - +Returns whether @type "is a" %G_TYPE_FLAGS. -@type: +@type: a #GType ID. diff --git a/docs/reference/gobject/tmpl/gclosure.sgml b/docs/reference/gobject/tmpl/gclosure.sgml index 062681649..97210ac94 100644 --- a/docs/reference/gobject/tmpl/gclosure.sgml +++ b/docs/reference/gobject/tmpl/gclosure.sgml @@ -63,7 +63,7 @@ Functions as first-class objects - +The #GType for #GClosure. @@ -328,14 +328,14 @@ atfer this function, unles g_closure_ref() was called beforehand. - +The #GType for #GIOChannel. - +The #GType for #GIOCondition. diff --git a/docs/reference/gobject/tmpl/param_value_types.sgml b/docs/reference/gobject/tmpl/param_value_types.sgml index 8db4da530..b8941c85f 100644 --- a/docs/reference/gobject/tmpl/param_value_types.sgml +++ b/docs/reference/gobject/tmpl/param_value_types.sgml @@ -45,7 +45,7 @@ Return whether the given #GValue can hold values of type %G_TYPE_BOOLEAN. - +The #GType of #GParamSpecBoolean. @@ -115,7 +115,7 @@ Return whether the given #GValue can hold values of type %G_TYPE_CHAR. - +The #GType of #GParamSpecChar. @@ -189,7 +189,7 @@ Return whether the given #GValue can hold values of type %G_TYPE_UCHAR. - +The #GType of #GParamSpecUChar. @@ -263,7 +263,7 @@ Return whether the given #GValue can hold values of type %G_TYPE_INT. - +The #GType of #GParamSpecInt. @@ -337,7 +337,7 @@ Return whether the given #GValue can hold values of type %G_TYPE_UINT. - +The #GType of #GParamSpecUInt. @@ -411,7 +411,7 @@ Return whether the given #GValue can hold values of type %G_TYPE_LONG. - +The #GType of #GParamSpecLong. @@ -485,7 +485,7 @@ Return whether the given #GValue can hold values of type %G_TYPE_ULONG. - +The #GType of #GParamSpecULong. @@ -559,7 +559,7 @@ Return whether the given #GValue can hold values of type %G_TYPE_INT64. - +The #GType of #GParamSpecInt64. @@ -633,7 +633,7 @@ Return whether the given #GValue can hold values of type %G_TYPE_UINT64. - +The #GType of #GParamSpecUInt64. @@ -707,7 +707,7 @@ Return whether the given #GValue can hold values of type %G_TYPE_FLOAT. - +The #GType of #GParamSpecFloat. @@ -782,7 +782,7 @@ Return whether the given #GValue can hold values of type %G_TYPE_DOUBLE. - +The #GType of #GParamSpecDouble. @@ -833,18 +833,18 @@ Get the contents of a %G_TYPE_DOUBLE #GValue. - +Returns whether the given #GParamSpec is of type %G_TYPE_PARAM_ENUM. -@pspec: +@pspec: a valid #GParamSpec instance - +Cast a #GParamSpec instance into a #GParamSpecEnum. -@pspec: +@pspec: a valid #GParamSpec instance @@ -857,7 +857,7 @@ Get the contents of a %G_TYPE_DOUBLE #GValue. - +The #GType of #GParamSpecEnum. @@ -905,18 +905,18 @@ Get the contents of a %G_TYPE_DOUBLE #GValue. - +Returns whether the given #GParamSpec is of type %G_TYPE_PARAM_FLAGS. -@pspec: +@pspec: a valid #GParamSpec instance - +Cast a #GParamSpec instance into a #GParamSpecChar. -@pspec: +@pspec: a valid #GParamSpec instance @@ -929,7 +929,7 @@ Get the contents of a %G_TYPE_DOUBLE #GValue. - +The #GType of #GParamSpecFlags. @@ -977,18 +977,18 @@ Get the contents of a %G_TYPE_DOUBLE #GValue. - +Returns whether the given #GParamSpec is of type %G_TYPE_PARAM_STRING. -@pspec: +@pspec: a valid #GParamSpec instance - +Casts a #GParamSpec instance into a #GParamSpecString. -@pspec: +@pspec: a valid #GParamSpec instance @@ -1001,7 +1001,7 @@ Get the contents of a %G_TYPE_DOUBLE #GValue. - +The #GType of #GParamSpecString. @@ -1085,18 +1085,18 @@ Get the contents of a %G_TYPE_DOUBLE #GValue. - +Returns whether the given #GParamSpec is of type %G_TYPE_PARAM_PARAM. -@pspec: +@pspec: a valid #GParamSpec instance - +Casts a #GParamSpec instance into a #GParamSpecParam. -@pspec: +@pspec: a valid #GParamSpec instance @@ -1109,7 +1109,7 @@ Get the contents of a %G_TYPE_DOUBLE #GValue. - +The #GType of #GParamSpecParam. @@ -1196,7 +1196,7 @@ Return whether the given #GValue can hold values derived from type %G_TYPE_BOXED - +The #GType of #GParamSpecBoxed. @@ -1272,18 +1272,18 @@ later freed with g_boxed_free(), e.g. like: g_boxed_free (G_VALUE_TYPE (@value), - +Returns whether the given #GParamSpec is of type %G_TYPE_PARAM_POINTER. -@pspec: +@pspec: a valid #GParamSpec instance - +Casts a #GParamSpec instance into a #GParamSpecPointer. -@pspec: +@pspec: a valid #GParamSpec instance @@ -1296,7 +1296,7 @@ later freed with g_boxed_free(), e.g. like: g_boxed_free (G_VALUE_TYPE (@value), - +The #GType of #GParamSpecPointer. @@ -1340,18 +1340,18 @@ later freed with g_boxed_free(), e.g. like: g_boxed_free (G_VALUE_TYPE (@value), - +Returns whether the given #GParamSpec is of type %G_TYPE_PARAM_OBJECT. -@pspec: +@pspec: a valid #GParamSpec instance - +Casts a #GParamSpec instance into a #GParamSpecObject. -@pspec: +@pspec: a valid #GParamSpec instance @@ -1364,7 +1364,7 @@ later freed with g_boxed_free(), e.g. like: g_boxed_free (G_VALUE_TYPE (@value), - +The #GType of #GParamSpecObject. @@ -1443,7 +1443,7 @@ Cast a #GParamSpec instance into a #GParamSpecUnichar. - +The #GType of #GParamSpecUnichar. @@ -1489,7 +1489,7 @@ Cast a #GParamSpec instance into a #GParamSpecValueArray. - +The #GType of #GParamSpecValueArray.