summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatthias Clasen <matthiasc@src.gnome.org>2006-04-24 21:12:52 +0000
committerMatthias Clasen <matthiasc@src.gnome.org>2006-04-24 21:12:52 +0000
commit5dd378d2bda2d8bf48cb5b04ae97c6622fa06ddf (patch)
treed80798308c037e93ac01db51e6578f147933e7f0
parent8506d702578dca2dae5bf6179b416c78b667cb83 (diff)
Updates
-rw-r--r--docs/reference/ChangeLog4
-rw-r--r--docs/reference/gobject/gobject-sections.txt18
-rw-r--r--docs/reference/gobject/tmpl/gobject-unused.sgml40
-rw-r--r--docs/reference/gobject/tmpl/gtype.sgml26
-rw-r--r--docs/reference/gobject/tmpl/objects.sgml99
-rw-r--r--docs/reference/gobject/tmpl/param_value_types.sgml20
-rw-r--r--docs/reference/gobject/tmpl/signals.sgml2
7 files changed, 114 insertions, 95 deletions
diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index bf954e626..c42046f9d 100644
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,5 +1,9 @@
2006-04-21 Matthias Clasen <mclasen@redhat.com>
+ * gobject/gobject-sections.txt:
+ * gobject/tmpl/objects.sgml:
+ * gobject/tmpl/gtype.sgml: Additions
+
* glib/glib-docs.sgml:
* gobject/gobject-docs.sgml: Add 2.12 indices.
diff --git a/docs/reference/gobject/gobject-sections.txt b/docs/reference/gobject/gobject-sections.txt
index 2259293a3..43f12e0f8 100644
--- a/docs/reference/gobject/gobject-sections.txt
+++ b/docs/reference/gobject/gobject-sections.txt
@@ -141,6 +141,7 @@ G_TYPE_POINTER
G_TYPE_BOXED
G_TYPE_PARAM
G_TYPE_OBJECT
+G_TYPE_GTYPE
<SUBSECTION>
G_TYPE_RESERVED_GLIB_FIRST
@@ -160,6 +161,7 @@ g_object_type_init
g_param_spec_types_init
g_value_transforms_init
g_signal_init
+g_gtype_get_type
</SECTION>
<SECTION>
@@ -239,6 +241,9 @@ GParameter
g_object_ref
g_object_unref
g_object_ref_sink
+GInitiallyUnowned
+GInitiallyUnownedClass
+G_TYPE_INITIALLY_UNOWNED
g_object_is_floating
g_object_force_floating
GWeakNotify
@@ -272,8 +277,18 @@ g_object_get_valist
g_object_watch_closure
g_object_run_dispose
G_OBJECT_WARN_INVALID_PROPERTY_ID
+
+<SUBSECTION Standard>
+G_INITIALLY_UNOWNED
+G_INITIALLY_UNOWNED_CLASS
+G_INITIALLY_UNOWNED_GET_CLASS
+G_IS_INITIALLY_UNOWNED
+G_IS_INITIALLY_UNOWNED_CLASS
+
<SUBSECTION Private>
G_OBJECT_WARN_INVALID_PSPEC
+g_initially_unowned_get_type
+g_object_compat_control
</SECTION>
<SECTION>
@@ -650,9 +665,12 @@ g_param_spec_override
<SUBSECTION GType>
G_IS_PARAM_SPEC_GTYPE
G_PARAM_SPEC_GTYPE
+G_VALUE_HOLDS_GTYPE
G_TYPE_PARAM_GTYPE
GParamSpecGType
g_param_spec_gtype
+g_value_get_gtype
+g_value_set_gtype
<SUBSECTION Private>
g_value_set_instance
diff --git a/docs/reference/gobject/tmpl/gobject-unused.sgml b/docs/reference/gobject/tmpl/gobject-unused.sgml
index a9347e4a3..e10d7c939 100644
--- a/docs/reference/gobject/tmpl/gobject-unused.sgml
+++ b/docs/reference/gobject/tmpl/gobject-unused.sgml
@@ -94,6 +94,46 @@ The predefined identifiers of the reserved fundamental types.
@G_TYPE_PARAM_CLOSURE:
@G_TYPE_PARAM_OBJECT:
+<!-- ##### MACRO G_INITIALLY_UNOWNED ##### -->
+<para>
+Casts a #GInitiallyUnowned or derived pointer into a (GInitiallyUnowned*)
+pointer. Depending on the current debugging level, this function may invoke
+certain runtime checks to identify invalid casts.
+</para>
+
+@object: Object which is subject to casting
+
+<!-- ##### MACRO G_INITIALLY_UNOWNED_CLASS ##### -->
+<para>
+Casts a derived #GInitiallyUnownedClass structure into a
+#GInitiallyUnownedClass structure.
+</para>
+
+@class: a valid #GInitiallyUnownedClass
+
+<!-- ##### MACRO G_INITIALLY_UNOWNED_GET_CLASS ##### -->
+<para>
+Returns the class structure associated to a #GInitiallyUnowned instance.
+</para>
+
+@object: a #GInitiallyUnowned instance
+
+<!-- ##### MACRO G_IS_INITIALLY_UNOWNED ##### -->
+<para>
+Checks whether a valid #GTypeInstance pointer is of type
+%G_TYPE_INITIALLY_UNOWNED.
+</para>
+
+@object: Instance to check for being a %G_TYPE_INITIALLY_UNOWNED.
+
+<!-- ##### MACRO G_IS_INITIALLY_UNOWNED_CLASS ##### -->
+<para>
+Checks whether @class "is a" valid #GInitiallyUnownedClass structure of type
+%G_TYPE_INITIALLY_UNOWNED or derived.
+</para>
+
+@class: a #GInitiallyUnownedClass
+
<!-- ##### MACRO G_IS_PARAM_SPEC_CLOSURE ##### -->
<para>
diff --git a/docs/reference/gobject/tmpl/gtype.sgml b/docs/reference/gobject/tmpl/gtype.sgml
index 19baa9895..1ca64db32 100644
--- a/docs/reference/gobject/tmpl/gtype.sgml
+++ b/docs/reference/gobject/tmpl/gtype.sgml
@@ -240,9 +240,9 @@ A structure that provides information to the type system which is
used specifically for managing interface types.
</para>
-@interface_init:
-@interface_finalize:
-@interface_data:
+@interface_init: location of the interface initialization function
+@interface_finalize: location of the interface finalization function
+@interface_data: user-supplied data passed to the interface init/finalize functions
<!-- ##### STRUCT GTypeValueTable ##### -->
<para>
@@ -1248,6 +1248,7 @@ struct and calling g_type_info_register_static().
@Returns: The new type identifier.
@Since: 2.12
+
<!-- ##### FUNCTION g_type_register_dynamic ##### -->
<para>
Registers @type_name as the name of a new dynamic type derived from
@@ -1635,25 +1636,6 @@ init functions.
@Since: 2.4
-<!-- ##### FUNCTION g_value_set_gtype ##### -->
-<para>
-Set the contents of a %G_TYPE_GTYPE #GValue to @v_gtype.
-</para>
-
-@value: a valid #GValue of type %G_TYPE_GTYPE
-@v_gtype: #GType to be set
-@Since: 2.12
-
-<!-- ##### FUNCTION g_value_get_gtype ##### -->
-<para>
-Get the contents of a %G_TYPE_GTYPE #GValue.
-</para>
-
-@value: a valid #GValue of type %G_TYPE_GTYPE
-@Returns: the #GType stored in @value
-@Since: 2.12
-
-
<!-- ##### MACRO G_TYPE_INVALID ##### -->
<para>
An invalid #GType, used as error return value in some functions which return
diff --git a/docs/reference/gobject/tmpl/objects.sgml b/docs/reference/gobject/tmpl/objects.sgml
index 83240fb5a..5ccea8da8 100644
--- a/docs/reference/gobject/tmpl/objects.sgml
+++ b/docs/reference/gobject/tmpl/objects.sgml
@@ -87,8 +87,7 @@ the setter for the property is called to reinstate the previous value.
</para>
@pspec: the #GParamSpec of the property which changed
-@:
-<!-- # Unused Parameters # -->
+@:
@gobject: the object which received the signal.
<!-- ##### STRUCT GObjectClass ##### -->
@@ -146,7 +145,6 @@ my_singleton_constructor (GType type,
needed.
@notify: the class closure for the notify signal
-
<!-- ##### STRUCT GObjectConstructParam ##### -->
<para>
The <structname>GObjectConstructParam</structname> struct is an auxiliary
@@ -446,13 +444,14 @@ Increases the reference count of @object.
</para>
@object: a #GObject
-@Returns: @object
+@Returns: the same @object
<!-- ##### FUNCTION g_object_unref ##### -->
<para>
-Decreases the reference count if @object.
-When its reference count drops to 0, the object is finalized (i.e. its memory is freed).
+Decreases the reference count of @object.
+When its reference count drops to 0, the object is finalized
+(i.e. its memory is freed).
</para>
@object: a #GObject
@@ -477,6 +476,27 @@ increasing the reference count by one.
@Since: 2.10
+<!-- ##### TYPEDEF GInitiallyUnowned ##### -->
+<para>
+All the fields in the <structname>GInitiallyUnowned</structname> structure
+are private to the #GInitiallyUnowned implementation and should never be
+accessed directly.
+</para>
+
+
+<!-- ##### TYPEDEF GInitiallyUnownedClass ##### -->
+<para>
+The class structure for the <structname>GInitiallyUnowned</structname> type.
+</para>
+
+
+<!-- ##### MACRO G_TYPE_INITIALLY_UNOWNED ##### -->
+<para>
+The type for #GInitiallyUnowned.
+</para>
+
+
+
<!-- ##### FUNCTION g_object_is_floating ##### -->
<para>
Checks wether @object has a <link linkend="floating-ref">floating</link>
@@ -631,6 +651,7 @@ reference count of the object is decreased by one.
@data: data to pass to @notify
@Since: 2.8
+
<!-- ##### FUNCTION g_object_connect ##### -->
<para>
A convenience function to connect multiple signals at once.
@@ -1065,69 +1086,3 @@ properties in set_property() and get_property() implementations.
@pspec: the #GParamSpec of the property
-<!-- ##### TYPEDEF GInitiallyUnowned ##### -->
-<para>
-All the fields in the <structname>GInitiallyUnowned</structname> structure
-are private to the #GInitiallyUnowned implementation and should never be
-accessed directly.
-</para>
-
-
-<!-- ##### TYPEDEF GInitiallyUnownedClass ##### -->
-<para>
-The class structure for the <structname>GInitiallyUnowned</structname> type.
-</para>
-
-
-<!-- ##### MACRO G_INITIALLY_UNOWNED ##### -->
-<para>
-Casts a #GInitiallyUnowned or derived pointer into a (GInitiallyUnowned*)
-pointer. Depending on the current debugging level, this function may invoke
-certain runtime checks to identify invalid casts.
-</para>
-
-@object: Object which is subject to casting
-
-
-<!-- ##### MACRO G_INITIALLY_UNOWNED_CLASS ##### -->
-<para>
-Casts a derived #GInitiallyUnownedClass structure into a
-#GInitiallyUnownedClass structure.
-</para>
-
-@class: a valid #GInitiallyUnownedClass
-
-
-<!-- ##### MACRO G_INITIALLY_UNOWNED_GET_CLASS ##### -->
-<para>
-Returns the class structure associated to a #GInitiallyUnowned instance.
-</para>
-
-@object: a #GInitiallyUnowned instance
-
-
-<!-- ##### MACRO G_IS_INITIALLY_UNOWNED ##### -->
-<para>
-Checks whether a valid #GTypeInstance pointer is of type
-%G_TYPE_INITIALLY_UNOWNED.
-</para>
-
-@object: Instance to check for being a %G_TYPE_INITIALLY_UNOWNED.
-
-
-<!-- ##### MACRO G_IS_INITIALLY_UNOWNED_CLASS ##### -->
-<para>
-Checks whether @class "is a" valid #GInitiallyUnownedClass structure of type
-%G_TYPE_INITIALLY_UNOWNED or derived.
-</para>
-
-@class: a #GInitiallyUnownedClass
-
-
-<!-- ##### MACRO G_TYPE_INITIALLY_UNOWNED ##### -->
-<para>
-The type for #GInitiallyUnowned.
-</para>
-
-
-
diff --git a/docs/reference/gobject/tmpl/param_value_types.sgml b/docs/reference/gobject/tmpl/param_value_types.sgml
index 6ed16a731..06850aae0 100644
--- a/docs/reference/gobject/tmpl/param_value_types.sgml
+++ b/docs/reference/gobject/tmpl/param_value_types.sgml
@@ -1766,3 +1766,23 @@ See g_param_spec_internal() for details on property names.
@Since: 2.10
+<!-- ##### FUNCTION g_value_get_gtype ##### -->
+<para>
+Get the contents of a %G_TYPE_GTYPE #GValue.
+</para>
+
+@value: a valid #GValue of type %G_TYPE_GTYPE
+@Returns: the #GType stored in @value
+@Since: 2.12
+
+
+<!-- ##### FUNCTION g_value_set_gtype ##### -->
+<para>
+Set the contents of a %G_TYPE_GTYPE #GValue to @v_gtype.
+</para>
+
+@value: a valid #GValue of type %G_TYPE_GTYPE
+@v_gtype: #GType to be set
+@Since: 2.12
+
+
diff --git a/docs/reference/gobject/tmpl/signals.sgml b/docs/reference/gobject/tmpl/signals.sgml
index ab14f40e6..1188d77b9 100644
--- a/docs/reference/gobject/tmpl/signals.sgml
+++ b/docs/reference/gobject/tmpl/signals.sgml
@@ -256,7 +256,7 @@ be used, but they cannot be mixed.
%G_SIGNAL_RUN_FIRST or %G_SIGNAL_RUN_LAST.
@class_offset: The offset of the function pointer in the class structure
for this type. Used to invoke a class method generically. Pass 0 to
- not associate a class method with this signal.
+ not associate a class method with this signal.
@accumulator: the accumulator for this signal; may be %NULL.
@accu_data: user data for the @accumulator.
@c_marshaller: the function to translate arrays of parameter values to