summaryrefslogtreecommitdiffstats
path: root/doc/commands.doc
diff options
context:
space:
mode:
authorDimitri van Heesch <dimitri@stack.nl>2001-05-24 16:25:58 (GMT)
committerDimitri van Heesch <dimitri@stack.nl>2001-05-24 16:25:58 (GMT)
commitcd76bda7e377a14bd6b3d321425cf462a46a3f75 (patch)
tree8572e4828627ab6b9a6d55d425469176c0c02e0b /doc/commands.doc
parent9b3aec9323189f25f4abb131b5a783fa110f45f6 (diff)
downloadDoxygen-cd76bda7e377a14bd6b3d321425cf462a46a3f75.zip
Doxygen-cd76bda7e377a14bd6b3d321425cf462a46a3f75.tar.gz
Doxygen-cd76bda7e377a14bd6b3d321425cf462a46a3f75.tar.bz2
Release-1.2.7-20010524
Diffstat (limited to 'doc/commands.doc')
-rw-r--r--doc/commands.doc31
1 files changed, 24 insertions, 7 deletions
diff --git a/doc/commands.doc b/doc/commands.doc
index a3b89e7..b0b9bc2 100644
--- a/doc/commands.doc
+++ b/doc/commands.doc
@@ -127,6 +127,7 @@ documentation:
<li> \refitem cmdverbinclude \verbinclude
<li> \refitem cmdversion \version
<li> \refitem cmdwarning \warning
+<li> \refitem cmdweakgroup \weakgroup
<li> \refitem cmddollar \$
<li> \refitem cmdat \@
<li> \refitem cmdbackslash \\
@@ -150,10 +151,14 @@ Doxygen. Unrecognized commands are treated as normal text.
Structural indicators
\htmlonly --- </center>\endhtmlonly</h2>
-\subsection cmdaddtogroup \addtogroup <name>
+\subsection cmdaddtogroup \addtogroup <name> [(title)]
\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
+ Defines a group just like \ref cmddefgroup "\\defgroup", but in contrast to
+ that command using the same \<name\> more than once will not result in a warning,
+ but rather one group with a merged documentation and the first title found in
+ any of the commands.
+
+ The title is optional, so this command can also be used to add a number of
entities to an existing group using \@{ and \@} like this:
\verbatim
@@ -177,7 +182,8 @@ Doxygen. Unrecognized commands are treated as normal text.
/*! @} */
\endverbatim
- See also \ref cmddefgroup "\\defgroup" and \ref cmdingroup "\\ingroup".
+ \sa page \ref grouping "Grouping", sections \ref cmddefgroup "\\defgroup", \ref cmdingroup "\\ingroup" and
+ \ref cmdweakgroup "\\weakgroup".
\subsection cmdclass \class <name> [<header-file>] [<header-name>]
@@ -225,9 +231,10 @@ Doxygen. Unrecognized commands are treated as normal text.
categories. You can also use groups as members of other groups,
thus building a hierarchy of groups.
- The \<name\> argument should an single word identifier.
+ The \<name\> argument should be a single word identifier.
- \sa section \ref cmdingroup "\\ingroup"
+ \sa page \ref grouping "Grouping", sections \ref cmdingroup "\\ingroup", \ref cmdaddtogroup "\\addtogroup",
+ \ref cmdweakgroup "\\weakgroup".
<hr>
@@ -348,7 +355,8 @@ Doxygen. Unrecognized commands are treated as normal text.
class, file or namespace, then it will be added to the group or
groups identified by \<groupname\>.
- \sa section \ref cmddefgroup "\\defgroup".
+ \sa page \ref grouping "Grouping", sections \ref cmddefgroup "\\defgroup",
+ \ref cmdaddtogroup "\\addtogroup" and \ref cmdweakgroup "\\weakgroup"
<hr>
\subsection cmdinterface \interface
@@ -556,6 +564,15 @@ Public/Protected/Private/... section.
\sa section \ref cmdfn "\\fn" and \ref cmdtypedef "\\typedef".
<hr>
+\subsection cmdweakgroup \weakgroup <name> [(title)]
+ \addindex \addtogroup
+ Can be used exactly like \ref cmdaddtogroup "\\addtogroup", but has
+ a lower priority when it comes to resolving conflicting grouping
+ definitions.
+
+ \sa page \ref grouping "Grouping" and \ref cmdaddtogroup "\\addtogroup".
+
+<hr>
<h2>\htmlonly <center> --- \endhtmlonly
Section indicators