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 668744 - incomplete documentation of base classes is conspicuous
incomplete documentation of base classes is conspicuous
Status: RESOLVED FIXED
Product: gtk+
Classification: Platform
Component: Documentation
2.24.x
Other All
: Normal normal
: ---
Assigned To: gtk-bugs
gtk-bugs
Depends on: 688896
Blocks:
 
 
Reported: 2012-01-26 14:36 UTC by Allison Karlitskaya (desrt)
Modified: 2014-11-14 13:29 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description Allison Karlitskaya (desrt) 2012-01-26 14:36:18 UTC
i've heard it reported to me a couple of times now that the incomplete documentation of things as fundamental as signals on GtkWidget is a bit of an embarrassment.

many of our signals, for example, have no docs at all beyond the parameters:

widget : the object which received the signal.
user_data : user data set when the signal handler was connected.

which is pretty useless.

we need to go through and fill these in better.  ideally, a description of what it means and under what circumstances it is fired.  at the very least, if we don't expect people to understand what its purpose is we should have a note to the effect of "this is an internal signal not intended to be used from outside of gtk".
Comment 1 Matthias Clasen 2012-01-26 21:39:16 UTC
really ?!

if that got reported to me, I'd invite people to chime in with patches...

in general, opening bugs about 'this should be documented' or 'that should be documented' is pretty ineffective.
Comment 2 William Jon McCann 2014-01-22 06:36:54 UTC
Any in particular that are missing?
Comment 3 Javier Jardón (IRC: jjardon) 2014-11-14 13:29:29 UTC
Seems this has been fixed by William in commit 1763b94fb291ae3d41414a84869555582356a49c