Documenting return values ( return )
Documenting return values from functions or macros is done using the keyword
\return
. The return value i listed last in the parameter table like shown here: HowToDocument::Return.
Syntax
\return Return value description ...
|
Output
See
HowToDocument::ReturnValue for a example.
About section commands
This command is a section command (also called
"Special Sections"). Common to all section commands is the fact that the section continues until a blank line or another section command is encountered.
The section commands are:
\bug, \deprecated, \throw, \internal, \note, \param, \remark, \sa, \todo, \warning
(Multiple commands are allowed yielding a bulleted list)
\author, \brief, \return, \version
(Only intended to be used once per entity)