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 731989 - XML comments and tags in GObject documentation
XML comments and tags in GObject documentation
Status: RESOLVED OBSOLETE
Product: glib
Classification: Platform
Component: docs
2.40.x
Other Linux
: Normal minor
: ---
Assigned To: gtkdev
gtkdev
Depends on:
Blocks:
 
 
Reported: 2014-06-20 20:32 UTC by Michael Catanzaro
Modified: 2018-05-24 16:40 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description Michael Catanzaro 2014-06-20 20:32:37 UTC
From the documentation for G_DEFINE_TYPE_WITH_PRIVATE: [1]

"A convenience macro for type implementations, which declares a class initialization function, an instance initialization function (see GTypeInfo for information about these), a static variable named t_n <!-- -->_parent_class pointing to the parent class, and adds private instance data to the type. Furthermore, it defines a *_get_type() function. See G_DEFINE_TYPE_EXTENDED() for an example.

Note that private structs added with this macros must have a struct name of the form <replaceable>TN </replaceable>Private."

A quick search on just that page shows another comment in the description of G_DEFINE_TYPE and one in the description of GTypeClassCacheFunc, and one more use of <replaceable> in the description of G_ADD_PRIVATE.

[1] https://developer.gnome.org/gobject/stable/gobject-Type-Information.html#G-DEFINE-TYPE:CAPS
Comment 2 Matthias Clasen 2014-06-29 15:56:32 UTC
these are all fixed in master, from what I can see
Comment 3 Michael Catanzaro 2014-07-06 01:27:41 UTC
A couple more on the GClosure page [1] that I'm not sure how to handle....

[1] https://developer.gnome.org/gobject/unstable/gobject-Closures.html
Comment 4 GNOME Infrastructure Team 2018-05-24 16:40:41 UTC
-- GitLab Migration Automatic Message --

This bug has been migrated to GNOME's GitLab instance and has been closed from further activity.

You can subscribe and participate further through the new bug through this link to our GitLab instance: https://gitlab.gnome.org/GNOME/glib/issues/892.