examples/group.cpp

   1 /** @defgroup group1 The First Group
   2  *  This is the first group
   3  *  @{
   4  */
   5
   6 /** @brief class C1 in group 1 */
   7 class C1 {};
   8
   9 /** @brief class C2 in group 1 */
  10 class C2 {};
  11
  12 /** function in group 1 */
  13 void func() {}
  14
  15 /** @} */ // end of group1
  16
  17 /**
  18  *  @defgroup group2 The Second Group
  19  *  This is the second group
  20  */
  21
  22 /** @defgroup group3 The Third Group
  23  *  This is the third group
  24  */
  25
  26 /** @defgroup group4 The Fourth Group
  27  *  @ingroup group3
  28  *  Group 4 is a subgroup of group 3
  29  */
  30
  31 /**
  32  *  @ingroup group2
  33  *  @brief class C3 in group 2
  34  */
  35 class C3 {};
  36
  37 /** @ingroup group2
  38  *  @brief class C4 in group 2
  39  */
  40 class C4 {};
  41
  42 /** @ingroup group3
  43  *  @brief class C5 in @link group3 the third group@endlink.
  44  */
  45 class C5 {};
  46
  47 /** @ingroup group1 group2 group3 group4
  48  *  namespace N1 is in four groups
  49  *  @sa @link group1 The first group@endlink, group2, group3, group4
  50  *
  51  *  Also see @ref mypage2
  52  */
  53 namespace N1 {};
  54
  55 /** @file
  56  *  @ingroup group3
  57  *  @brief this file in group 3
  58  */
  59
  60 /** @defgroup group5 The Fifth Group
  61  *  This is the fifth group
  62  *  @{
  63  */
  64
  65 /** @page mypage1 This is a section in group 5
  66  *  Text of the first section
  67  */
  68
  69 /** @page mypage2 This is another section in group 5
  70  *  Text of the second section
  71  */
  72
  73 /** @} */ // end of group5
  74
  75 /** @addtogroup group1
  76  *
  77  *  More documentation for the first group.
  78  *  @{
  79  */
  80
  81 /** another function in group 1 */
  82 void func2() {}
  83
  84 /** yet another function in group 1 */
  85 void func3() {}
  86
  87 /** @} */ // end of group1
  88