Making a "Todo" section ( todo ).
For making a bullet entry in the "Todo" section on the bottom of the page. The todo sections are mainly meant for the developpers of the code and therefore they can be turned ON or OFF in the generated output by setting TODO_DOCS in the configuration file (see
OutputCustomization).
Syntax
\todo We have stuff todo.
|
Output
See below in the
Todo section.
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, \deprecated, \throw, \internal, \note, \param, \remark, \sa, \todo, \warning
(Multiple commands are allowed yielding a bulleted list)
\author, \brief, \return, \version
(Only intended to be used once per entity)