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 316512 - add list of ignorable decorators for function declarations to gtkdoc-scan
add list of ignorable decorators for function declarations to gtkdoc-scan
Status: RESOLVED FIXED
Product: gtk-doc
Classification: Platform
Component: general
1.4
Other All
: Normal enhancement
: ---
Assigned To: gtk-doc maintainers
gtk-doc maintainers
Depends on:
Blocks:
 
 
Reported: 2005-09-16 19:42 UTC by Bertram Felgenhauer
Modified: 2006-03-19 18:51 UTC
See Also:
GNOME target: ---
GNOME version: ---

Attachments
proposed patch (3.88 KB, patch)
2005-09-16 19:44 UTC, Bertram Felgenhauer 		none Details | Review

Description Bertram Felgenhauer 2005-09-16 19:42:17 UTC 
It would be nice to be able to specify a list of additional declarators for
function declarations that are ignored by gtkdoc. Example:

[cairo.h]
cairo_public int
cairo_version (void);

Right now, gtkdoc gets confused by the cairo_public and produces no useful
documentation at all.

The attached patch implements such a feature. I freely admit that it's tailored
for the current usage in cairo; it does not handle additional declarators
between the type and the function, for example.
Comment 1 Bertram Felgenhauer 2005-09-16 19:44:12 UTC 
Created attachment 52323 [details] [review]
proposed patch

Changelog:

2005-09-16  Bertram Felgenhauer  <int-e@gmx.de>

	* gtkdoc-scan.in (ScanHeader): added ignoring a configurable list of
	declarators in function declarations
Comment 2 Stefan Sauer (gstreamer, gtkdoc dev) 2006-02-13 09:05:15 UTC 
I see the need for a mechanism like this. Patch looks okay too. It will beome a bit messy if there a lot of decorators to ignore (long list).

Damon what do you think? Should we commit.
Especialy before next release?
Comment 3 Damon Chaplin 2006-03-19 18:51:06 UTC 
committed to cvs. thanks.