@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  

@return <description>
...
<end of comment or empty line>

Example  

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)  

This function is declared in doc/examples.h source file, line 113.

This function converts a string to an integer.

The return value is the result of conversion.

Valid XHTML 1.0 StrictGenerated by diaxen on Sun Jan 8 22:43:00 2012 using MkDoc