HELP - Todo
HelpExample CodeHowToDocumentTodo
Description Source Call Graph
HowToDocument::Todo ( Public Method )
Author: N.F.S Grundtvig (The members of this class inherits the author by default.)
Making todo's (internal use mainly).
 
Syntax / parameters
void Todo()

Description
Making todo's (internal use mainly).

This is done using the keyword: \todo.

Todo comments are intended for use by the developers of the code/library and not for the users of the library. You can use TODO_DOCS in the config file to show or hide the todo documentation.

This is how it looks in the source:
\todo We have stuff todo!
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:


See also
  • Internal (\internal)
  • Todo
  • We have stuff todo!
  •  
    Source
    The documentation for this Member was generated from the following files:
  • HowtoDocument.cpp
  • HowtoDocument.h