summaryrefslogtreecommitdiffstats
path: root/doc/commands.doc
diff options
context:
space:
mode:
authordimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7>2001-04-30 17:28:34 (GMT)
committerdimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7>2001-04-30 17:28:34 (GMT)
commit3e8e2e531ac41a9d4729375151b6af6493a61fd7 (patch)
treee2fe643e6fc6aabac8311560e2258318c1dead5a /doc/commands.doc
parent9a1a3728724df58e6fc9196651f8e8c8f23f1e2d (diff)
downloadDoxygen-3e8e2e531ac41a9d4729375151b6af6493a61fd7.zip
Doxygen-3e8e2e531ac41a9d4729375151b6af6493a61fd7.tar.gz
Doxygen-3e8e2e531ac41a9d4729375151b6af6493a61fd7.tar.bz2
Release-1.2.7
Diffstat (limited to 'doc/commands.doc')
-rw-r--r--doc/commands.doc36
1 files changed, 33 insertions, 3 deletions
diff --git a/doc/commands.doc b/doc/commands.doc
index 21f0b6e..bdbbbae 100644
--- a/doc/commands.doc
+++ b/doc/commands.doc
@@ -45,6 +45,7 @@ documentation:
\endlatexonly
<li> \refitem cmda \a
<li> \refitem cmdaddindex \addindex
+<li> \refitem cmdaddtogroup \addtogroup
<li> \refitem cmdanchor \anchor
<li> \refitem cmdarg \arg
<li> \refitem cmdattention \attention
@@ -148,6 +149,35 @@ Doxygen. Unrecognized commands are treated as normal text.
Structural indicators
\htmlonly --- </center>\endhtmlonly</h2>
+\subsection cmdaddtogroup \addtogroup <name>
+ \addindex \addtogroup
+ Add extra documentation to a group \<name\> that was previously defined
+ using \\defgroup. This command can also be used to add a number of
+ entities to an existing group using \@{ and \@} like this:
+
+\verbatim
+ /*! \addtogroup mygrp
+ * Additional documentation for group `mygrp'
+ * @{
+ */
+
+ /*!
+ * A function
+ */
+ void func1()
+ {
+ }
+
+ /*! Another function */
+ void func2()
+ {
+ }
+
+ /*! @} */
+\endverbatim
+
+ See also \ref cmddefgroup "\\defgroup" and \ref cmdingroup "\\ingroup".
+
\subsection cmdclass \class <name> [<header-file>] [<header-name>]
\addindex \class
@@ -180,7 +210,7 @@ Doxygen. Unrecognized commands are treated as normal text.
\par Example:
\verbinclude define.h
\htmlonly
- Click <a href="$(DOXYGEN_DOCDIR)/examples/define/html/define_h.html">here</a>
+ Click <a href="$(DOXYGEN_DOCDIR)/examples/define/html/define_8h.html">here</a>
for the corresponding HTML documentation that is generated by Doxygen.
\endhtmlonly
@@ -271,7 +301,7 @@ Doxygen. Unrecognized commands are treated as normal text.
\par Example:
\verbinclude file.h
\htmlonly
- Click <a href="$(DOXYGEN_DOCDIR)/examples/file/html/file_h.html">here</a>
+ Click <a href="$(DOXYGEN_DOCDIR)/examples/file/html/file_8h.html">here</a>
for the corresponding HTML documentation that is generated by Doxygen.
\endhtmlonly
@@ -547,7 +577,7 @@ Public/Protected/Private/... section.
\par Example:
\verbinclude author.cpp
\htmlonly
- Click <a href="$(DOXYGEN_DOCDIR)/examples/author/html/class_windowsnt.html">here</a>
+ Click <a href="$(DOXYGEN_DOCDIR)/examples/author/html/class_windows_n_t.html">here</a>
for the corresponding HTML documentation that is generated by Doxygen.
\endhtmlonly