GNOME Bugzilla – Bug 587103
return values of function-like macros
Last modified: 2012-02-21 09:49:57 UTC
gobject doc comments for e.g. g_signal_connect have a Returns: line, but it doesn't survive in the docs. Probably because g_signal_connect is a macro ? See bug 581038
It seems to be a regression and there is an example for it in gtk-doc/tests/gobject the GTKDOC_OBJECT_MACRO_SUM macro.
In gtk-doc tests it works, I just wrote "Return:" instead of "Returns:". Although in the deprecated tmpl based docs it fails, someone needs to figure out and fix it, but apart glib/gtk should really move the stuff inline.
Matthias, are you sure that this ever worked?
The gobject docs are all inline nowadays, actually. And I am not sure that it ever worked.
Right, I merged them :) For the gtk-doc tests it now works both ways: commit 4e0c66b59f6437d24b195a0ebb016832c3509dbc Author: Stefan Kost <ensonic@users.sf.net> Date: Sat Jun 27 19:10:57 2009 +0300 mkdb: merge returns for tmpl based docs, Fixes #587103 Could you test with git version?
The patch fixes it. gobject has all docs merge, but you still use the tmpl files. If you want to speed up the docs build, migrate the rest of glib to use inline docs and use gtkdocize --flavour no-tmpl in autogen.sh. Everyone will be happy :)
*** Bug 581038 has been marked as a duplicate of this bug. ***