HELP - Remark
HelpExample CodeHowToDocumentRemark
Description Source Call Graph
HowToDocument::Remark ( Public Method )
Author: N.F.S Grundtvig (The members of this class inherits the author by default.)
Making remarks to the reader of the documentation.
 
Syntax / parameters
void Remark()

Description
Making remarks to the reader of the documentation.

This is done using the keyword: \remark.

This is how it looks in the source:
\remark This is a remark. Remarkable :-)
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:


Remarks
  • This is a remark. Remarkable :-)
  •  
    Source
    The documentation for this Member was generated from the following files:
  • HowtoDocument.cpp
  • HowtoDocument.h