luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-12-25 06:56:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

GClosure docu fixes from Guillaume Cottenceau, #383155.

Browse Source 
Mon Jul  9 10:23:53 2007  Tim Janik  <timj@imendio.com>                                                                                                       
                                                                                                                                                              
        * gobject/tmpl/gclosure.sgml: GClosure docu fixes from Guillaume                                                                                      
        Cottenceau, #383155.                                                                                                                                  
                                                                                                                                                              


svn path=/trunk/; revision=5610
This commit is contained in:
Tim Janik 2007-07-09 08:25:14 +00:00 committed by Tim Janik
parent e9e1d9d45f
commit 3a132f5dd5
2 changed files with 24 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/reference/ChangeLog
View File

@ -1,3 +1,8 @@
Mon Jul 9 10:23:53 2007 Tim Janik <timj@imendio.com>
* gobject/tmpl/gclosure.sgml: GClosure docu fixes from Guillaume
Cottenceau, #383155.
Fri Jun 29 2007 Matthias Clasen <mclasen@redhat.com>
* === Released 2.13.6 ===

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

@ -242,7 +242,7 @@ alive while the caller holds a pointer to it.
<!-- ##### FUNCTION g_closure_sink ##### -->
<para>
Takes over the initial ownership of a closure.
Each closure is initially created in a<firstterm>floating</firstterm> state,
Each closure is initially created in a <firstterm>floating</firstterm> state,
which means that the initial reference count is not owned by any caller.
g_closure_sink() checks to see if the object is still floating, and if so,
unsets the floating state and decreases the reference count. If the closure
@ -360,8 +360,10 @@ invoked before finalization notifiers, in an unspecified order.
<!-- ##### FUNCTION g_closure_remove_finalize_notifier ##### -->
<para>
Removes a finalization notifier. Notifiers are automatically removed after
they are run.
Removes a finalization notifier.
</para>
<para>
Notice that notifiers are automatically removed after they are run.
</para>
@closure: a #GClosure
@ -372,8 +374,11 @@ they are run.
<!-- ##### FUNCTION g_closure_remove_invalidate_notifier ##### -->
<para>
Removes a invalidation notifier. Notifiers are automatically removed after
they are run.
Removes an invalidation notifier.
</para>
<para>
Notice that notifiers are automatically removed after they are run.
</para>
@closure: a #GClosure
@ -432,11 +437,12 @@ MyClosure *my_closure_new (gpointer data)
<!-- ##### FUNCTION g_closure_set_marshal ##### -->
<para>
Sets the marshaller of @closure. The @marshal_data provides a way for a
meta marshaller to provide additional information to the marshaller.
(See g_closure_set_meta_marshal().) For GObject's C predefined marshallers
(the g_cclosure_marshal_*() functions), what it provides is a callback
function to use instead of @closure->callback.
Sets the marshaller of @closure. The <literal>marshal_data</literal>
of @marshal provides a way for a meta marshaller to provide additional
information to the marshaller. (See g_closure_set_meta_marshal().) For
GObject's C predefined marshallers (the g_cclosure_marshal_*()
functions), what it provides is a callback function to use instead of
@closure->callback.
</para>
@closure: a #GClosure
@ -466,8 +472,8 @@ in some fashion. The most common use of this facility is for C callbacks.
The same marshallers (generated by
<link linkend="glib-genmarshal">glib-genmarshal</link>) are used everywhere,
but the way that we get the callback function differs. In most cases we want
to use @closure->callback, but in other cases we want to use use some
different technique to retrieve the callbakc function.
to use @closure->callback, but in other cases we want to use some
different technique to retrieve the callback function.
</para>
<para>
For example, class closures for signals (see g_signal_type_cclosure_new())
@ -487,7 +493,7 @@ Set the callback for a source as a #GClosure.
</para>
<para>
If the source is not one of the standard GLib types, the @closure_callback
and @closure_marshal fields of the GSourceFuncs structure must have been
and @closure_marshal fields of the #GSourceFuncs structure must have been
filled in with pointers to appropriate functions.
</para>