AutoDoc



Root

Index

Commenting the source code


Source files can include doc comments. Doc comments begin with /** and indicate text to be included automaticaly in generated documentation:
/**
This is a doc comment
*/
Next, you can include a part of source code to doc comment. This special type of doc comments has two parts, one begins with /**+ and another begins with /*-. All source lines between this two perts will included to documentation.

For example:

/**+
This is the first part of doc comment
*/
    String m_text;      // text of document item
    String m_node;      // path of document item
    String m_title;     // title of document item
/*-
This is the second part of doc comment
*/
AutoDoc includes all source lines with WHITE background color:
    String m_text;      // text of document item
    String m_node;      // path of document item
    String m_title;     // title of document item

AutoDoc v1.0.
e-mail: Navernyuk@iName.com