Blame tests/upstream-test-suite/009_bug.cpp

Than Ngo b7bcaa
// objective: test the \bug, \deprecated, \todo, \test, and \xrefitem commands
Than Ngo b7bcaa
// check: class_bug.xml
Than Ngo b7bcaa
// check: class_deprecated.xml
Than Ngo b7bcaa
// check: class_todo.xml
Than Ngo b7bcaa
// check: class_test.xml
Than Ngo b7bcaa
// check: class_reminder.xml
Than Ngo b7bcaa
// check: bug.xml
Than Ngo b7bcaa
// check: deprecated.xml
Than Ngo b7bcaa
// check: todo.xml
Than Ngo b7bcaa
// check: test.xml
Than Ngo b7bcaa
// check: reminders.xml
Than Ngo b7bcaa
// config: ALIASES = "reminder=\xrefitem reminders \"Reminder\" \"Reminders\""
Than Ngo b7bcaa
Than Ngo b7bcaa
/** \bug Class bug. */
Than Ngo b7bcaa
class Bug
Than Ngo b7bcaa
{
Than Ngo b7bcaa
  public:
Than Ngo b7bcaa
    /** Description
Than Ngo b7bcaa
     *  \bug Function bug
Than Ngo b7bcaa
     *  - list item 1 in bug
Than Ngo b7bcaa
     *  - list item 2 in bug
Than Ngo b7bcaa
     *
Than Ngo b7bcaa
     *  More text.
Than Ngo b7bcaa
     */
Than Ngo b7bcaa
     void foo();
Than Ngo b7bcaa
};
Than Ngo b7bcaa
Than Ngo b7bcaa
/** \deprecated This class is deprecated */
Than Ngo b7bcaa
class Deprecated
Than Ngo b7bcaa
{
Than Ngo b7bcaa
  public:
Than Ngo b7bcaa
    /** Do deprecated things.
Than Ngo b7bcaa
     *  \deprecated No not use this function anymore. 
Than Ngo b7bcaa
     */
Than Ngo b7bcaa
    void deprecated();
Than Ngo b7bcaa
};
Than Ngo b7bcaa
Than Ngo b7bcaa
/** \todo This still needs to be done. */
Than Ngo b7bcaa
class Todo
Than Ngo b7bcaa
{
Than Ngo b7bcaa
  public:
Than Ngo b7bcaa
    /** \todo more things to do here */
Than Ngo b7bcaa
    void todo();
Than Ngo b7bcaa
};
Than Ngo b7bcaa
Than Ngo b7bcaa
/** \test This is part of testing */
Than Ngo b7bcaa
class Test
Than Ngo b7bcaa
{
Than Ngo b7bcaa
  public:
Than Ngo b7bcaa
    /** \test more things to test. */
Than Ngo b7bcaa
    void test();
Than Ngo b7bcaa
};
Than Ngo b7bcaa
Than Ngo b7bcaa
/** \reminder A reminder */
Than Ngo b7bcaa
class Reminder
Than Ngo b7bcaa
{
Than Ngo b7bcaa
  public:
Than Ngo b7bcaa
    /** \reminder Need to rework this before the next release. */
Than Ngo b7bcaa
    void reminder();
Than Ngo b7bcaa
};
Than Ngo b7bcaa
Than Ngo b7bcaa