The @Todo Tag

Syntax

@todo description

Synonyms

None.

Description

This is info for the coders (only) of the class, method or routine. A @todo is something which is meant to be fixed before the next release. It is not the same as @bug, because a bug may be too expensive to fix, or otherwise does not warrant it being fixed. A @todo is often "stronger" than @bug, but not necessarily so. Use one tag per "todo". Can be used everywhere.

Time2HELP generates reports listing all the @todo's and @bug's found in a library/project.

HTML generated by Time2HELP

http://www.time2help.com