After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 528719 - Improvement to the documentation of the "g_object_connect" interface
Improvement to the documentation of the "g_object_connect" interface
Status: RESOLVED FIXED
Product: glib
Classification: Platform
Component: docs
2.16.x
Other Linux
: Normal normal
: ---
Assigned To: gtk-bugs
gtk-bugs
Depends on:
Blocks:
 
 
Reported: 2008-04-18 10:58 UTC by Areg Beketovski
Modified: 2008-06-11 16:36 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description Areg Beketovski 2008-04-18 10:58:18 UTC
Documentation Section:
http://library.gnome.org/devel/gobject/stable/gobject-The-Base-Object-Type.html#g-object-connect

Description of the interface "g_object_connect" contains the following text:

    * signal - equivalent to g_signal_connect_data (...)
    * object_signal, object-signal - equivalent to g_signal_connect_object (...)
    * swapped_signal, swapped-signal - equivalent to g_signal_connect_data (..., G_CONNECT_SWAPPED)
    * swapped_object_signal, swapped-object-signal - equivalent to g_signal_connect_object (..., G_CONNECT_SWAPPED)
    * signal_after, signal-after - equivalent to g_signal_connect_data (..., G_CONNECT_AFTER)
    * object_signal_after, object-signal-after - equivalent to g_signal_connect_object (..., G_CONNECT_AFTER)
    * swapped_signal_after, swapped-signal-after - equivalent to g_signal_connect_data (..., G_CONNECT_SWAPPED | G_CONNECT_AFTER)
    * swapped_object_signal_after, swapped-object-signal-after - equivalent to g_signal_connect_object (..., G_CONNECT_SWAPPED | G_CONNECT_AFTER)



Proposed version:
It is proposed to improve the documentation by specifying the missing parameter values:

    * signal - equivalent to g_signal_connect_data (..., NULL, 0)
    * object_signal, object-signal - equivalent to g_signal_connect_object (..., 0)
    * swapped_signal, swapped-signal - equivalent to g_signal_connect_data (..., NULL, G_CONNECT_SWAPPED)
    * swapped_object_signal, swapped-object-signal - equivalent to g_signal_connect_object (..., G_CONNECT_SWAPPED)
    * signal_after, signal-after - equivalent to g_signal_connect_data (..., NULL, G_CONNECT_AFTER)
    * object_signal_after, object-signal-after - equivalent to g_signal_connect_object (..., G_CONNECT_AFTER)
    * swapped_signal_after, swapped-signal-after - equivalent to g_signal_connect_data (..., NULL, G_CONNECT_SWAPPED | G_CONNECT_AFTER)
    * swapped_object_signal_after, swapped-object-signal-after - equivalent to g_signal_connect_object (..., G_CONNECT_SWAPPED | G_CONNECT_AFTER)



Other information:
The detailed issue description can be found at: 

http://linuxtesting.org/results/report?num=D0085
Comment 1 Matthias Clasen 2008-06-11 16:36:10 UTC
        * gobject/tmpl/objects.sgml: Improve the documentation of
        g_object_connect. Proposed by Areg Bketovski