Variable itcl_var1 #< Documented itcl var \c itcl_var1. # Documented common itcl var \c itcl_Var. # Documented itcl method \c itcl_method_z. # Documented itcl method \c itcl_method_y. # Documented itcl method \c itcl_method_x. 'TCL_SUBST = class=itcl:class body=itcl:body'įollowing is a example using doxygen style comments: To use the itcl::* commands without the leading namespace use p.e.: The entry contain a list of word-keyword mappings. To use your own keywords you an map these keyword to the recognized commands using the "TCL_SUBST" entry in the config file. Will be appended to method documentation. Documentation blocks can be put on the lines before the command. To detect namespaces, classes, functions and variables the following Tcl commands are recognized.
DOXYGEN TUTORIAL CODE
If a doxygen comment block ends with a line containing only #\verbatim or all code until a line only containing #\endverbatim or is added verbatim to the generated documentation. If a doxygen comment block ends with a line containing only #\code or all code until a line only containing #\endcode or is added to the generated documentation as code block.
The ony difference are described in the following two paragraphs. Inside doxygen comment blocks all normal doxygen markings are supported. The brief documentation also ends at a line not starting with a # (hash sign). The block ends with a line not starting with a # (hash sign).Ī brief documentation can be added with #< (semicolon, hash and lower then sign).
All following comment lines and continuation lines will be added to this block. To start a new documentation block start a line with # (two hashes). ĭoxygen documentation can be included in normal Tcl comments. The last release with Tcl support is 1.8.18 link.
0 kommentar(er)
