Root/
| Source at commit 1322 created 12 years 8 months ago. By meklort, Add doxygen to utils folder | |
|---|---|
| 1 | //! A test class. ␊ |
| 2 | /*!␊ |
| 3 | A more elaborate class description.␊ |
| 4 | */␊ |
| 5 | ␊ |
| 6 | class Test␊ |
| 7 | {␊ |
| 8 | public:␊ |
| 9 | ␊ |
| 10 | //! An enum.␊ |
| 11 | /*! More detailed enum description. */␊ |
| 12 | enum TEnum { ␊ |
| 13 | TVal1, /*!< Enum value TVal1. */ ␊ |
| 14 | TVal2, /*!< Enum value TVal2. */ ␊ |
| 15 | TVal3 /*!< Enum value TVal3. */ ␊ |
| 16 | } ␊ |
| 17 | //! Enum pointer.␊ |
| 18 | /*! Details. */␊ |
| 19 | *enumPtr, ␊ |
| 20 | //! Enum variable.␊ |
| 21 | /*! Details. */␊ |
| 22 | enumVar; ␊ |
| 23 | ␊ |
| 24 | //! A constructor.␊ |
| 25 | /*!␊ |
| 26 | A more elaborate description of the constructor.␊ |
| 27 | */␊ |
| 28 | Test();␊ |
| 29 | ␊ |
| 30 | //! A destructor.␊ |
| 31 | /*!␊ |
| 32 | A more elaborate description of the destructor.␊ |
| 33 | */␊ |
| 34 | ~Test();␊ |
| 35 | ␊ |
| 36 | //! A normal member taking two arguments and returning an integer value.␊ |
| 37 | /*!␊ |
| 38 | \param a an integer argument.␊ |
| 39 | \param s a constant character pointer.␊ |
| 40 | \return The test results␊ |
| 41 | \sa Test(), ~Test(), testMeToo() and publicVar()␊ |
| 42 | */␊ |
| 43 | int testMe(int a,const char *s);␊ |
| 44 | ␊ |
| 45 | //! A pure virtual member.␊ |
| 46 | /*!␊ |
| 47 | \sa testMe()␊ |
| 48 | \param c1 the first argument.␊ |
| 49 | \param c2 the second argument.␊ |
| 50 | */␊ |
| 51 | virtual void testMeToo(char c1,char c2) = 0;␊ |
| 52 | ␊ |
| 53 | //! A public variable.␊ |
| 54 | /*!␊ |
| 55 | Details.␊ |
| 56 | */␊ |
| 57 | int publicVar;␊ |
| 58 | ␊ |
| 59 | //! A function variable.␊ |
| 60 | /*!␊ |
| 61 | Details.␊ |
| 62 | */␊ |
| 63 | int (*handler)(int a,int b);␊ |
| 64 | };␊ |
| 65 | ␊ |
| 66 | |
