Designating a brief description section ( brief )
The brief description should give a first one line introduction to what the symbol is or does. It is parsed from the beginning of the comment block description, until the first full stop or line break, see
HowToDocument::BriefAndDescription. The brief description is shown on lists (class, function, overview etc.) to give a first introduction to the symbol.
\\brief command (only use in rare cases)
The brief command is used to override this behavior and explicitly define a brief description. It is
NOT intended to be used except for rare cases.
Syntax
\brief This is a brief description which spans several lines
of text. It continues until a blank line or until a new section command is encountered
So this is not part of the brief description....
|
Output
See
HowToDocument::BriefCmd
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, \throw, \internal, \note, \param, \remark, \sa, \todo, \warning \since
(Multiple commands are allowed yielding a bulleted list)
\author \version (Multiple commands are are comma separated in output)
- \brief, \return, \deprecated (Only intended to be used once per entity)