GNOME Bugzilla – Bug 314267
macros can return results too
Last modified: 2005-09-29 08:48:14 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?
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.
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.
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.
Yes, that looks fine.