testing/009_bug.cpp

   1 // objective: test the \bug, \deprecated, \todo, \test, and \xrefitem commands
   2 // check: class_bug.xml
   3 // check: class_deprecated.xml
   4 // check: class_todo.xml
   5 // check: class_test.xml
   6 // check: class_reminder.xml
   7 // check: bug.xml
   8 // check: deprecated.xml
   9 // check: todo.xml
  10 // check: test.xml
  11 // check: reminders.xml
  12 // config: ALIASES = "reminder=\xrefitem reminders \"Reminder\" \"Reminders\""
  13
  14 /** \bug Class bug. */
  15 class Bug
  16 {
  17   public:
  18     /** Description
  19      *  \bug Function bug
  20      *  - list item 1 in bug
  21      *  - list item 2 in bug
  22      *
  23      *  More text.
  24      */
  25      void foo();
  26 };
  27
  28 /** \deprecated This class is deprecated */
  29 class Deprecated
  30 {
  31   public:
  32     /** Do deprecated things.
  33      *  \deprecated No not use this function anymore.
  34      */
  35     void deprecated();
  36 };
  37
  38 /** \todo This still needs to be done. */
  39 class Todo
  40 {
  41   public:
  42     /** \todo more things to do here */
  43     void todo();
  44 };
  45
  46 /** \test This is part of testing */
  47 class Test
  48 {
  49   public:
  50     /** \test more things to test. */
  51     void test();
  52 };
  53
  54 /** \reminder A reminder */
  55 class Reminder
  56 {
  57   public:
  58     /** \reminder Need to rework this before the next release. */
  59     void reminder();
  60 };
  61
  62