examples/memgrp.cpp

   1 /** A class. Details */
   2 class Test
   3 {
   4   public:
   5     //@{
   6     /** Same documentation for both members. Details */
   7     void func1InGroup1();
   8     void func2InGroup1();
   9     //@}
  10
  11     /** Function without group. Details. */
  12     void ungroupedFunction();
  13     void func1InGroup2();
  14   protected:
  15     void func2InGroup2();
  16 };
  17
  18 void Test::func1InGroup1() {}
  19 void Test::func2InGroup1() {}
  20
  21 /** @name Group2
  22  *  Description of group 2.
  23  */
  24 ///@{
  25 /** Function 2 in group 2. Details. */
  26 void Test::func2InGroup2() {}
  27 /** Function 1 in group 2. Details. */
  28 void Test::func1InGroup2() {}
  29 ///@}
  30
  31 /*! \file
  32  *  docs for this file
  33  */
  34
  35 //!@{
  36 //! one description for all members of this group
  37 //! (because DISTRIBUTE_GROUP_DOC is YES in the config file)
  38 #define A 1
  39 #define B 2
  40 void glob_func();
  41 //!@}