/****************************************************************************** * * * * Copyright (C) 1997-2015 by Dimitri van Heesch. * * Permission to use, copy, modify, and distribute this software and its * documentation under the terms of the GNU General Public License is hereby * granted. No representations are made about the suitability of this software * for any purpose. It is provided "as is" without express or implied warranty. * See the GNU General Public License for more details. * * Documents produced by Doxygen are derivative works derived from the * input used in their production; they are not affected by this license. * */ /*! \page grouping Grouping Doxygen has three mechanisms to group things together. One mechanism works at a global level, creating a new page for each group. These groups are called \ref modules "'modules'" in the documentation. The second mechanism works within a member list of some compound entity, and is referred to as a \ref memgroup "'member groups'". For \ref cmdpage "pages" there is a third grouping mechanism referred to as \ref subpaging "subpaging". \section modules Modules Modules are a way to group things together on a separate page. You can document a group as a whole, as well as all individual members. Members of a group can be files, namespaces, classes, functions, variables, enums, typedefs, and defines, but also other groups. 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. The second argument is the name or title of the group as it should appear in the documentation. You can make an entity a member of a specific group by putting a \ref cmdingroup "\\ingroup" command inside its documentation block. To avoid putting \ref cmdingroup "\\ingroup" commands in the documentation for each member you can also group members together by the open marker \@{ before the group and the closing marker \@} after the group. The markers can be put in the documentation of the group definition or in a separate documentation block. Groups themselves can also be nested using these grouping markers. You will get an error message when you use the same group label more than once. If you don't want doxygen to enforce unique labels, then you can use \ref cmdaddtogroup "\\addtogroup" instead of \ref cmddefgroup "\\defgroup". It can be used exactly like \ref cmddefgroup "\\defgroup", but when the group has been defined already, then it silently merges the existing documentation with the new one. The title of the group is optional for this command, so you can use \verbatim /** \addtogroup