GNOME Bugzilla – Bug 490637
gobject documentation patch
Last modified: 2007-11-13 07:13:20 UTC
Here's a patch with various fixes to the GObject documentation: - I modified the documentation to recommend type macro names of the form MODULE_TYPE_CLASS (e.g. NAUTILUS_TYPE_WINDOW) as are always used in practice in GNOME code. Previously the doc recommended names of the form MODULE_CLASS_TYPE (this was either an error or a historical artifact). This was in the "Conventions" section. - I removed text which erroneously stated that superclass initializers don't run when an object is instantiated; this was in the section "Instantiable classed types: object", subsection "Initialization and Destruction". - I've fixed dozens of spelling mistakes and have made numerous grammatical fixes. This documentation could still use more copy editing, but hopefully this is a step in the right direction.
Created attachment 97946 [details] [review] patch
(In reply to comment #0) > - I removed text which erroneously stated that superclass initializers don't > run when an object is instantiated; this was in the section "Instantiable > classed types: object", subsection "Initialization and Destruction". > - I've fixed dozens of spelling mistakes and have made numerous grammatical > fixes. > As far as I understand it this refers to GType/g_type_create_instance and not GObject, which is introduced later. In that context the text is accurate. It is GObject that provides the C++-like behavior.
(In reply to comment #2) > As far as I understand it this refers to GType/g_type_create_instance and not > GObject, which is introduced later. In that context the text is accurate. It is > GObject that provides the C++-like behavior. > But of course I missed the point, the instance_init function of the parent class is indeed called.
(In reply to comment #1) > Created an attachment (id=97946) [edit] > patch thanks, for the most part, the patch seems to fix the docs for the better. i'd really like to see smaller doc patches in the future if possible though, at least from me that'll get you quicker review, and it's also easier to address possible changes in individual sections that way. bratsche, tbf, can you please take care of applying?
2007-11-13 Cody Russell <bratsche@gnome.org> * docs/reference/gobject/gobject-docs.sgml: * docs/reference/gobject/tut_gsignal.xml: * docs/reference/gobject/tut_gtype.xml: * docs/reference/gobject/tut_intro.xml: * docs/reference/gobject/tut_tools.xml: * docs/reference/gobject/tut_howto.xml: * docs/reference/gobject/tut_gobject.xml: Documentation fixes. Recommend macro type names such as NAUTILUS_TYPE_WINDOW (not NAUTILUS_WINDOW_TYPE). Fixed text which erroneously stated that superclass initializers don't run when an object is instantiated. Fixed numerous spelling mistakes. Minor grammar edits. (#490637, Adam Dingle) Committed to trunk and glib-2-14 branch. Thanks Adam!