summaryrefslogtreecommitdiffstats
path: root/doc/commands.doc
diff options
context:
space:
mode:
authordimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7>2000-05-08 20:42:05 (GMT)
committerdimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7>2000-05-08 20:42:05 (GMT)
commit6c268019f8ce8b58058e7f7f8204c82b8d0ac190 (patch)
tree28a24e8c88d32a50bc5bef6d49306553267dc5ab /doc/commands.doc
parentb5fb0aa0f1c2a5373ed97b127e2daeeb81ab38f2 (diff)
downloadDoxygen-6c268019f8ce8b58058e7f7f8204c82b8d0ac190.zip
Doxygen-6c268019f8ce8b58058e7f7f8204c82b8d0ac190.tar.gz
Doxygen-6c268019f8ce8b58058e7f7f8204c82b8d0ac190.tar.bz2
Release-1.1.3
Diffstat (limited to 'doc/commands.doc')
-rw-r--r--doc/commands.doc25
1 files changed, 15 insertions, 10 deletions
diff --git a/doc/commands.doc b/doc/commands.doc
index c5ca24e..b0fdee8 100644
--- a/doc/commands.doc
+++ b/doc/commands.doc
@@ -85,6 +85,7 @@ documentation:
<li> \refitem cmdline \line
<li> \refitem cmdlink \link
<li> \refitem cmdmainpage \mainpage
+<li> \refitem cmdname \name
<li> \refitem cmdnamespace \namespace
<li> \refitem cmdoverload \overload
<li> \refitem cmdpage \page
@@ -186,20 +187,13 @@ Doxygen. Unrecognized commands are treated as normal text.
\addindex \defgroup
Indicates that a comment block contains documentation for a
- group of classes, files or namespaces. This can be used to
+ \ref modules "group" of classes, files or namespaces. This can be used to
categorize classes, files or namespaces, and document those
- categories.
+ categories. You can also uses groups as members of other groups,
+ thus building a hierarchy of groups.
The \<name\> argument should an single word identifier.
- \par Example:
- \verbinclude group.cpp
-
- \htmlonly
- Click <a href="$(DOXYGEN_DOCDIR)/examples/group/html/modules.html">here</a>
- for the corresponding HTML documentation that is generated by Doxygen.
- \endhtmlonly
-
\sa section \ref cmdingroup "\\ingroup"
<hr>
@@ -355,6 +349,17 @@ Doxygen. Unrecognized commands are treated as normal text.
section \ref cmdpage "\\page".
<hr>
+\subsection cmdname \name (header)
+
+This command turns a comment block into a header
+definition of a member group. The
+comment block should be followed by a
+<code>//@{ ... //@}</code> block containing the
+members of the group.
+
+See section \ref memgroup for an example.
+
+<hr>
\subsection cmdnamespace \namespace <name>
\addindex \namespace