1/*! \brief kurze Beschreibung (im vorhinein)
2 * Ergaenzung der kurzen Beschreibung
3 *
4 * laengerer Beschreibungstext
5 */
6int testVar = 0;
7
8int testVar = 0; //!< Beschreibung der Variable, nachfolgend
9int testVar = 0; /*!< Beschreibung der Variable, nachfolgend */
10
11
12/*! \class testClass
13 * \brief kurze Beschreibung
14 */
15class testClass
16{
17public:
18 /*! \fn testClass
19 * \brief Beschreibung des Konstruktors
20 */
21 testClass();
22 /*! \fn testClass
23 * \brief Beschreibung des Destruktors
24 */
25 ~testClass();
26
27 int value1; //!< Beschreibung der Variable
28
29protected:
30 /*! \fn set
31 * \brief Beschreibung von Methoden
32 */
33 void set(int value);
34 /*! \fn get
35 * \brief Beschreibung von Methoden
36 */
37 int get(void);
38
39 int value2;
40private:
41 int value3;
42};
43
44
45/*! \struct zur Dokumentation einer C-Struktur
46 * \class zur Dokumentation einer Klasse
47 * \union zur Dokumentation einer Union
48 * \enum zur Dokumentation eines Enumeration Typs
49 * \fn zur Dokumentation einer Funktion
50 * \var zur Dokumentation einer Variable
51 * \def zur Dokumentation eines #defines
52 * \typedef zur Dokumentation einer Typ Definition
53 * \file zur Dokumentation einer Datei
54 * \namespace zur Dokumentation eines Namensraumes
55 */
56
57
58/*! \param value1 - Beschreibung von Variablen in Parameterlisten
59 * \param [in] value1 - Beschreibung von Eingabeparametern
60 * \param [out] value1 - Beschreibung von Ausgabeparametern
61 * \return Beschreibung des Rueckgabewertes
62 * \retval value1 - Beschreibung bestimmter Return Werte
63 * \pre Pre-Kondition
64 * \post Post-Kondition
65 */
66
67
68/*! \note zusaetzliche Notizen
69 * \author Angaben zum Erzeuger des Codes
70 * \version Version des Codes
71 * \date Datum der Erstellung
72 * \test Testbeschreibung
73 * \todo Aufgaben die noch erledigt gehoeren
74 */
75
76/*! Erstellung einer Liste
77 * - Aufzaehlung 1
78 * - Aufzaehlung 2
79 * -# verschachtelte numerierte Aufzaehlung 1
80 * -# verschachtelte numerierte Aufzaehlung 2
81 */
82
83
84/*! verschiedene Textformate
85 * /verbatim Verbatim Textausgabe
86 * /endverbatim
87 *
88 * /code Codeausgabe
89 * /endcode
90 */
91
92/*! Einbetten einer Formel
93 *
94 * \f$\sqrt{f_{under}^{over}}\f$
95 *
96 * zwischen den \f$ Marken koennen standard
97 * Latex Formel Beschreibungen eingegeben werden
98 */
99
100
101/*! \brief <big> es koennen auch HTML Kommandos eingebunden werden </big>
102 */
103
104
