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 314267 - macros can return results too
macros can return results too
Status: RESOLVED FIXED
Product: gtk-doc
Classification: Platform
Component: general
unspecified
Other Linux
: Normal minor
: ---
Assigned To: gtk-doc maintainers
gtk-doc maintainers
Depends on:
Blocks:
 
 
Reported: 2005-08-23 13:55 UTC by Stefan Sauer (gstreamer, gtkdoc dev)
Modified: 2005-09-29 08:48 UTC
See Also:
GNOME target: ---
GNOME version: ---

Attachments
add handling of the macro case (1.23 KB, patch)
2005-09-25 17:51 UTC, Stefan Sauer (gstreamer, gtkdoc dev) 		none Details | Review

Description Stefan Sauer (gstreamer, gtkdoc dev) 2005-08-23 13:55:28 UTC 
WARNING: Parameter described in source code comment block but does not exist -
         MACRO: GST_BIN_NUMCHILDREN Parameter: Returns.

I'd like to try to change the behaviour of gtkdoc-mkdb to support macros
returning results. okay?
Comment 1 Damon Chaplin 2005-08-23 14:03:55 UTC 
We do seem to support "Returns" in some cases:

http://developer.gnome.org/doc/API/2.0/glib/glib-Standard-Macros.html#MAX:CAPS

Maybe it is just the inline comment blocks where it doesn't work.
Comment 2 Owen Taylor 2005-08-23 14:16:36 UTC 
For "function-like" macros, I've at times put them into 
foo.overrides as a function so that the types of the parameters
get documented.
Comment 3 Stefan Sauer (gstreamer, gtkdoc dev) 2005-09-25 17:51:40 UTC 
Created attachment 52638 [details] [review]
add handling of the macro case

The template builder cannot detect if a macro returns a result or not. This
causes the warning later on. The attached patch fixes the issue.
Comment 4 Damon Chaplin 2005-09-28 17:02:54 UTC 
Yes, that looks fine.