HELP - BriefAndDescription
HelpExample CodeHowToDocumentBriefAndDescription
Description Source Call Graph
HowToDocument::BriefAndDescription ( Public Method )
Author: N.F.S Grundtvig (The members of this class inherits the author by default.)
The brief description ends at first punctuation mark (or see BriefToNewline).
 
Syntax / parameters
void BriefAndDescription()

Description
The brief description ends at first punctuation mark (or see BriefToNewline).

The description continues here with what you find the users of the documented entity might want to know. All fomatting like: bold, italics, Headlines lists, tables, images, examples etc. work here.

All shown here applies to all kinds of entities (functions, macros, variables, namespaces etc.) not just functions and classes.

Brief on multiple lines
Although it's not recommended to let the brief description expand multiple lines it is possible using the \brief command see: BriefCmd().

This is how it looks in the source:
/** 
The brief description ends at first punctuation mark (or see BriefToNewline ). 
The description continues here with what you find the users of the documented 
entity might want to know. All fomatting like: #bold#, }italics}, Headlines
lists, tables, images, examples etc. work here. ...
*/



 
Source
The documentation for this Member was generated from the following files:
  • HowtoDocument.cpp
  • HowtoDocument.h