HELP - ReturnValue
HelpExample CodeHowToDocumentReturnValue
Description Source Call Graph
HowToDocument::ReturnValue ( Const Public Method )
Author: N.F.S Grundtvig (The members of this class inherits the author by default.)
Documenting return values.
 
Syntax / parameters
int ReturnValue () const

Return value int
This is the return value documentation. It can be as long as you may wish, like other standard sections.
Description
Documenting return values.
This is how it looks in the source:
\return This is the return value documentation. It can be as long as
you may wish, like other standard sections.

About section commands
This command is a section command (also called special section). 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:
Notes
  • To provide compatibility with original Doxygen the following aliases for the \return command also works: \returns, \retval
  •  
    Source
    The documentation for this Member was generated from the following files:
  • HowtoDocument.cpp
  • HowtoDocument.h