@return tag
This tag can used to describe a function return value.
The description will be inserted as a paragraph with "The return value is" statement prepended. This tag starts a new paragraph.
Syntax [link]
@return <description>
...
<end of comment or empty line>Example [link]
This declarations:
/**
This function converts a string to an integer.
@return the result of conversion.
*/
int atoi(const char *str);
generates the following member details:
int atoi(const char *str) [link]
This function is declared in doc/examples.h source file, line 109.
This function converts a string to an integer.
The return value is the result of conversion.