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

Improve glib-genmarshal man page

Browse Source 
Expand the example in glib-genmarshal.1 to include the actual
commandline invocations, and update the generated function
names to match reality.
https://bugzilla.gnome.org/show_bug.cgi?id=637460
This commit is contained in:
Matthias Clasen 2012-08-16 18:44:41 -04:00
parent aa50b8aec3
commit 2ccf64ba59
1 changed files with 14 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/reference/gobject/glib-genmarshal.xml
View File

@ -333,7 +333,7 @@ gfloat baz (gpointer data1,
gpointer data2); gpointer data2);
</programlisting> </programlisting>
<para> <para>
The marshaller list has to look like this: The <filename>marshaller.list</filename> file has to look like this:
</para> </para>
<programlisting> <programlisting>
VOID:VOID VOID:VOID
@ -341,13 +341,20 @@ VOID:INT
FLOAT:BOOLEAN,UCHAR FLOAT:BOOLEAN,UCHAR
</programlisting> </programlisting>
<para> <para>
and you call glib-genmarshal like this:
</para>
<programlisting>
glib-genmarshal --header marshaller.list > marshaller.h
glib-genmarshal --body marshaller.list > marshaller.c
</programlisting>
<para>
The generated marshallers have the arguments encoded in their function name. The generated marshallers have the arguments encoded in their function name.
For this particular list, they are For this particular list, they are
</para> </para>
<programlisting> <programlisting>
g_cclosure_marshal_VOID__VOID(), g_cclosure_user_marshal_VOID__VOID(),
g_cclosure_marshal_VOID__INT(), g_cclosure_user_marshal_VOID__INT(),
g_cclosure_marshal_FLOAT__BOOLEAN_UCHAR(). g_cclosure_user_marshal_FLOAT__BOOLEAN_UCHAR().
</programlisting> </programlisting>
<para> <para>
They can be used directly for GClosures or be passed in as the They can be used directly for GClosures or be passed in as the
@ -357,11 +364,11 @@ GSignalCMarshaller c_marshaller; argument upon creation of signals:
GClosure *cc_foo, *cc_bar, *cc_baz; GClosure *cc_foo, *cc_bar, *cc_baz;
cc_foo = g_cclosure_new (NULL, foo, NULL); cc_foo = g_cclosure_new (NULL, foo, NULL);
g_closure_set_marshal (cc_foo, g_cclosure_marshal_VOID__VOID); g_closure_set_marshal (cc_foo, g_cclosure_user_marshal_VOID__VOID);
cc_bar = g_cclosure_new (NULL, bar, NULL); cc_bar = g_cclosure_new (NULL, bar, NULL);
g_closure_set_marshal (cc_bar, g_cclosure_marshal_VOID__INT); g_closure_set_marshal (cc_bar, g_cclosure_user_marshal_VOID__INT);
cc_baz = g_cclosure_new (NULL, baz, NULL); cc_baz = g_cclosure_new (NULL, baz, NULL);
g_closure_set_marshal (cc_baz, g_cclosure_marshal_FLOAT__BOOLEAN_UCHAR); g_closure_set_marshal (cc_baz, g_cclosure_user_marshal_FLOAT__BOOLEAN_UCHAR);
</programlisting> </programlisting>
</refsect1> </refsect1>
<refsect1><title>See also</title> <refsect1><title>See also</title>