testing/025_example.cpp

   1 // objective: test the \example command
   2 // check: example_test_8cpp-example.xml
   3 // check: class_test.xml
   4
   5
   6 /** \brief A Test class.
   7  *
   8  *  More details about this class.
   9  */
  10 class Test
  11 {
  12   public:
  13     /** \brief An example member function.
  14      *
  15      *  More details about this function.
  16      */
  17     void example();
  18 };
  19
  20 void Test::example() {}
  21
  22 /** \example example_test.cpp
  23  * This is an example of how to use the Test class.
  24  *
  25  * More details about this example.
  26  */