summaryrefslogtreecommitdiffstats
path: root/doc/grouping.doc
diff options
context:
space:
mode:
authordimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7>2000-12-24 16:16:39 (GMT)
committerdimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7>2000-12-24 16:16:39 (GMT)
commite4cebf12a245705a0ecb714cd3794750af9d0844 (patch)
tree4d1a863a3e01975cb0300efd330b7a7fb560ee87 /doc/grouping.doc
parentba0681136c643f13bb56b3b44d4cba3c70c8338d (diff)
downloadDoxygen-e4cebf12a245705a0ecb714cd3794750af9d0844.zip
Doxygen-e4cebf12a245705a0ecb714cd3794750af9d0844.tar.gz
Doxygen-e4cebf12a245705a0ecb714cd3794750af9d0844.tar.bz2
Release-1.2.4
Diffstat (limited to 'doc/grouping.doc')
-rw-r--r--doc/grouping.doc16
1 files changed, 15 insertions, 1 deletions
diff --git a/doc/grouping.doc b/doc/grouping.doc
index 2f1bef7..a09cda0 100644
--- a/doc/grouping.doc
+++ b/doc/grouping.doc
@@ -33,7 +33,21 @@ To define a group, you should put the \ref cmddefgroup "\\defgroup"
command in a special comment block. The first argument of the command
is a label that should uniquely identify the group. You can make an
entity a member of a specific group by putting
-a \ref cmdingroup "\\ingroup" command inside its documentation.
+a \ref cmdingroup "\\ingroup" command inside its documentation block.
+
+To avoid putting \ref cmdingroup "\\ingroup" commands in the documentation
+of each member you can also group members together by the
+open marker <code>\@{</code> before the group and the
+closing marker <code>\@}</code> after the group. The markers can
+be put in the documentation of the group definition or in a separate
+documentation block.
+
+Groups can also be nested using these grouping markers.
+
+Note that compound entities (like classes, files and namespaces) can
+be put into multiple groups, but members (like variable, functions, typedefs
+and enums) can only be a member of one group
+(this restriction is to avoid ambiguous linking targets).
\par Example:
\verbinclude group.cpp