GNOME Bugzilla – Bug 673229
glib: Use Returns:, not @returns
Last modified: 2015-02-07 16:49:17 UTC
There are a number of return values specified in the parameter format, not the correct "Returns:" or "Return value:" as specified here: https://live.gnome.org/GObjectIntrospection/Annotations
Created attachment 211026 [details] [review] Fix return annotation
gobject-introspection probably needs to understand the @return format it as gtk-doc does.
The annotationparser now understands @returns parameter, Returns: and Return value: tags and internally standardises on the Returns: tag. Fixed in bug #672254.
Dieter, is the recommended default still 'Returns:'? The purpose of this patch was mostly to make the use in glib consistent and match the documentation so new annotations are done in a consistent format.
"Returns" and "Return value" are equivalent; it's @returns that is something not really valid, even though it's accepted by gtk-doc.
(In reply to comment #4) > Dieter, is the recommended default still 'Returns:'? The purpose of this patch > was mostly to make the use in glib consistent and match the documentation so > new annotations are done in a consistent format. Yeah, I misunderstood the intent of your patch and marked this bug as resolved in reaction to comment #2... (In reply to comment #5) > "Returns" and "Return value" are equivalent; it's @returns that is something > not really valid, even though it's accepted by gtk-doc. Yes, and the patch attached below addresses exactly that concern.
Comment on attachment 211026 [details] [review] Fix return annotation Unmarking obsolete based on comments. Can you rebase this against master? Also the commit message could be more descriptive, like "Use Returns:, not @returns parameter"
*** Bug 672783 has been marked as a duplicate of this bug. ***
Created attachment 227699 [details] [review] Use "Returns:" instead of the invalid "@returns" for annotating return values Updated to master.
Review of attachment 227699 [details] [review]: Looks good. Remember to add a reference to this bug in the commit message per the style guide from https://live.gnome.org/GnomeLove/SubmittingPatches
[Mass-moving gobject-introspection tickets to its own Bugzilla product - see bug 708029. Mass-filter your bugmail for this message: introspection20150207 ]