HELP - BriefCmd
HelpExample CodeHowToDocumentBriefCmd
Description Source Call Graph
HowToDocument::BriefCmd ( Public Method )
Author: N.F.S Grundtvig (The members of this class inherits the author by default.)
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
 
Syntax / parameters
void BriefCmd ()

Description
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
The description then continues here...

This is how it looks in the source:
/** 
\brief This is a brief description which spans several lines 
of text and continues until a blank line or untill a new section command is encountered

The description then continues here...
*/

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
  • This is mainly provided for compatibility with Doxygen or in the rare cases where you for some reason needs to span the brief over several lines.
  •  
    Source
    The documentation for this Member was generated from the following files:
  • HowtoDocument.cpp
  • HowtoDocument.h