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 65997 - Problems with @returns:
Problems with @returns:
Status: RESOLVED FIXED
Product: gtk-doc
Classification: Platform
Component: general
unspecified
Other other
: Normal normal
: ---
Assigned To: gtk-doc maintainers
gtk-doc maintainers
: 69660 (view as bug list)
Depends on:
Blocks:
 
 
Reported: 2001-12-02 22:39 UTC by Matthias Clasen
Modified: 2004-12-22 21:47 UTC
See Also:
GNOME target: ---
GNOME version: ---


Description Matthias Clasen 2001-12-02 22:39:15 UTC 
/**
 * pango_fontset_simple_size:
 * @fontset: a #PangoFontsetSimple.
 * @returns: the size of @fontset.
 *
 * Returns the number of fonts in the fontset.
 **/

doesn't work as expected, since gtk-doc scans the description
for "Returns" lines regardless of the @returns: parameter and
thus wrongly thinks that there is no description (ie the symbol
counts as undocumented).

Btw. @returns works only by accident: the function emitting
the docbook markup expects the return value to be the parameter
Comment 1 Matthias Clasen 2001-12-02 22:41:05 UTC 
Oops, lynx cut my bug...here is the rest:

named "Returns" and the @returns: parameter gets initally stored
under "returns". Only when the template docs are merged in,
the parameter names are compared case-insensitively and the
template parameter names are kept. Thankfully, the templates
generally contain @Returns: for the return value.
Comment 2 Havoc Pennington 2001-12-02 23:10:24 UTC 
Yeah I'm constantly having to rephrase docs to work around this. ;-)
Comment 3 Matthias Clasen 2002-02-10 00:05:36 UTC 
*** Bug 69660 has been marked as a duplicate of this bug. ***
Comment 4 Matthias Clasen 2002-04-22 09:30:39 UTC 
*** Bug 69660 has been marked as a duplicate of this bug. ***
Comment 5 Owen Taylor 2002-04-22 20:04:54 UTC 
Reassigning all open gtk-doc bugs to gtk-doc-maint