diff options
Diffstat (limited to 'src/reflist.h')
| -rw-r--r-- | src/reflist.h | 15 |
1 files changed, 10 insertions, 5 deletions
diff --git a/src/reflist.h b/src/reflist.h index cb60dc2..d282c13 100644 --- a/src/reflist.h +++ b/src/reflist.h @@ -32,7 +32,16 @@ struct RefItem bool written; }; -/*! Singleton for the one and only RefList */ +/*! @brief List of cross-referenced items + * + * This class represents a list of items that are put + * at a certain point in the documentation by some special command + * and are collected in a list. The items cross-reference the + * documentation and the list. + * + * Examples are the todo list, the test list and the bug list, + * introduced by the \\todo, \\test, and \\bug commands respectively. + */ class RefList { public: @@ -63,8 +72,4 @@ class RefList BaseOutputDocInterface::SectionTypes m_type; }; -//extern RefList todoList; -//extern RefList testList; -//extern RefList bugList; - #endif |