summaryrefslogtreecommitdiffstats
path: root/doc/grouping.doc
diff options
context:
space:
mode:
authorDimitri van Heesch <dimitri@stack.nl>2004-03-07 21:00:29 (GMT)
committerDimitri van Heesch <dimitri@stack.nl>2004-03-07 21:00:29 (GMT)
commitce05925c34c21ec1d2033970745a86affd039445 (patch)
treeecc570be1c038ecdb55dda6d9ffe794945151261 /doc/grouping.doc
parentf13d78d4dfe3e075e0f91ee8d62603fadf18a3a9 (diff)
downloadDoxygen-ce05925c34c21ec1d2033970745a86affd039445.zip
Doxygen-ce05925c34c21ec1d2033970745a86affd039445.tar.gz
Doxygen-ce05925c34c21ec1d2033970745a86affd039445.tar.bz2
Release-1.3.6-20040307
Diffstat (limited to 'doc/grouping.doc')
-rw-r--r--doc/grouping.doc8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/grouping.doc b/doc/grouping.doc
index 2a1fe89..e87b596 100644
--- a/doc/grouping.doc
+++ b/doc/grouping.doc
@@ -105,6 +105,14 @@ int IntegerVariable;
/*@}*/
\endverbatim
+The \ref cmdref "\\ref" command can be used to refer to a group.
+The first argument of the \\ref command should be group's label.
+To use a custom link name, you can put the name of the links in
+double quotes after the label, as shown by the following example
+\verbatim
+This is the \ref group_label "link" to this group.
+\endverbatim
+
The priorities of grouping definitions are (from highest to lowest):
\ref cmdingroup "\\ingroup", \ref cmddefgroup "\\defgroup",
\ref cmdaddtogroup "\\addtogroup", \ref cmdweakgroup "\\weakgroup".