Bug 594294 – [annotation] Add syntax for struct members

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 594294 - [annotation] Add syntax for struct members


Summary:	[annotation] Add syntax for struct members


Status:	RESOLVED DUPLICATE of bug 710561

Product:	gobject-introspection
Classification:	Platform
Component:	general
Version:	unspecified
Hardware:	Other Linux

Importance:	Normal enhancement
Target Milestone:	---
Assigned To:	gobject-introspection Maintainer(s)
QA Contact:	gobject-introspection Maintainer(s)

URL:
Whiteboard:

Depends on:
Blocks:

Reported:	2009-09-06 08:52 UTC by Sebastian Dröge (slomo)
Modified:	2015-02-07 16:50 UTC

See Also:
GNOME target:	---
GNOME version:	---

Description Sebastian Dröge (slomo) 2009-09-06 08:52:50 UTC

Hi,
there should be gtk-doc annotations for structs too, not only for functions.

For example:
/**
 * GstBin:
 * [...]
 * @children: (element-type Gst.Element): the list of children in this bin
 * [...]
 */
struct _GstBin {
[...]
  GList         *children;
[...]
};

Also the /* < private > */ gtk-doc annotations (and protected/public) should be parsed, but that's bug #594125.

Comment 1 Dan Winship 2010-04-26 19:45:14 UTC

yeah, i need this too. I have:

    typedef struct {
        const char *data;
        gsize       length;
    } SoupBuffer;

which I want to annotate as

    /**
     * SoupBuffer:
     * @data: (array length=length) (element-type uint8): the data
     * @length: length of @data

Comment 2 Sebastian Dröge (slomo) 2013-07-17 13:23:51 UTC

Any progress on this?

Comment 3 Simon Kågedal 2013-09-13 14:37:29 UTC

This bug is the same, I think: https://bugzilla.gnome.org/show_bug.cgi?id=561619

Comment 4 Emmanuele Bassi (:ebassi) 2013-09-13 15:12:39 UTC

Thanks for the bug report. This particular bug has already been reported into our bug tracking system, but please feel free to report any further bugs you find.

*** This bug has been marked as a duplicate of bug 561619 ***

Comment 5 Simon Feltman 2013-12-29 23:17:38 UTC

Changing dup to bug 710561 as it was actually fixed there.

*** This bug has been marked as a duplicate of bug 710561 ***

Comment 6 André Klapper 2015-02-07 16:50:13 UTC

[Mass-moving gobject-introspection tickets to its own Bugzilla product - see bug 708029. Mass-filter your bugmail for this message: introspection20150207 ]