Commit 4a292911 authored by Matthias Clasen's avatar Matthias Clasen

Documentation additions.

parent 04d27d22
Mon Oct 20 22:05:37 2003 Matthias Clasen <maclas@gmx.de>
* gobject/tmpl/objects.sgml:
* gobject/tmpl/enumerations_flags.sgml:
* gobject/tmpl/gtypeplugin.sgml: Additions.
Mon Oct 20 22:04:45 2003 Matthias Clasen <maclas@gmx.de>
* gobject/gobject-sections.txt: Add GObjectConstructParam.
Mon Oct 20 20:38:06 2003 Matthias Clasen <maclas@gmx.de>
* gobject/gobject.i: Removed...
......
......@@ -192,6 +192,7 @@ G_TYPE_MODULE_GET_CLASS
<FILE>objects</FILE>
GObject
GObjectClass
GObjectConstructParam
GObjectGetPropertyFunc
GObjectSetPropertyFunc
GObjectFinalizeFunc
......@@ -243,7 +244,6 @@ g_object_run_dispose
G_OBJECT_WARN_INVALID_PROPERTY_ID
<SUBSECTION Private>
G_OBJECT_WARN_INVALID_PSPEC
GObjectConstructParam
</SECTION>
<SECTION>
......
......@@ -118,22 +118,23 @@ Returns the static type name from a given #GFlagsClass structure.
<!-- ##### STRUCT GEnumValue ##### -->
<para>
A structure which contains a single enum value, its name, and it's
A structure which contains a single enum value, it's name, and it's
nickname.
</para>
@value:
@value_name:
@value_nick:
@value: the enum value
@value_name: the name of the value
@value_nick: the nickname of the value
<!-- ##### STRUCT GFlagsValue ##### -->
<para>
A structure which contains a single flags value, it's name, and it's
nickname.
</para>
@value:
@value_name:
@value_nick:
@value: the flags value
@value_name: the name of the value
@value_nick: the nickname of the value
<!-- ##### FUNCTION g_enum_get_value ##### -->
<para>
......
......@@ -72,7 +72,9 @@ handles multiple registered types per module.
<!-- ##### STRUCT GTypePlugin ##### -->
<para>
The <structname>GTypePlugin</structname> typedef is used as a placeholder
for objects that implement the <structname>GTypePlugin</structname>
interface.
</para>
......
......@@ -38,6 +38,23 @@ the setter for the property is called to reinstate the previous value.
</para>
@g_type_class:
@constructor:
@set_property:
@get_property:
@dispose:
@finalize:
@dispatch_properties_changed:
@notify:
<!-- ##### STRUCT GObjectConstructParam ##### -->
<para>
The <structname>GObjectConstructParam</structname> struct is an auxiliary
structure used to hand #GParamSpec/#GValue pairs to the @constructor of
a #GObjectClass.
</para>
@pspec: the #GParamSpec of the construct parameter
@value: the value to set the parameter to
<!-- ##### USER_FUNCTION GObjectGetPropertyFunc ##### -->
<para>
......
Mon Oct 20 22:06:12 2003 Matthias Clasen <maclas@gmx.de>
* gobject.h (struct _GObjectClass): Add /*< public >*/
and /*< private >*/ markers for documentation purposes.
Sat Oct 18 01:24:14 2003 Matthias Clasen <maclas@gmx.de>
* gtypeplugin.h (struct _GTypePluginClass): Add /*< public >*/
......
......@@ -75,7 +75,8 @@ struct _GObjectClass
/*< private >*/
GSList *construct_properties;
/* public overridable methods */
/*< public >*/
/* overridable methods */
GObject* (*constructor) (GType type,
guint n_construct_properties,
GObjectConstructParam *construct_properties);
......@@ -98,6 +99,7 @@ struct _GObjectClass
/* signals */
void (*notify) (GObject *object,
GParamSpec *pspec);
/*< private >*/
/* padding */
gpointer pdummy[8];
};
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment