summaryrefslogtreecommitdiffstats
path: root/src/reflist.h
diff options
context:
space:
mode:
authorDimitri van Heesch <dimitri@stack.nl>2002-07-07 17:23:26 (GMT)
committerDimitri van Heesch <dimitri@stack.nl>2002-07-07 17:23:26 (GMT)
commit457ca5c291eddeb1a4cd667e20cd8d7dfc1d7f2e (patch)
treef08f27e02ce20e8ca59117d6d02be98fbe3c8c24 /src/reflist.h
parent977ad9d3ec7dff388b8be849ae4a596ae5cd3ad4 (diff)
downloadDoxygen-457ca5c291eddeb1a4cd667e20cd8d7dfc1d7f2e.zip
Doxygen-457ca5c291eddeb1a4cd667e20cd8d7dfc1d7f2e.tar.gz
Doxygen-457ca5c291eddeb1a4cd667e20cd8d7dfc1d7f2e.tar.bz2
Release-1.2.16-20020707
Diffstat (limited to 'src/reflist.h')
-rw-r--r--src/reflist.h15
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