Hallo allerseits,
mit Doxygen arbeite ich nun schon seit geraumer Zeit und bin eigentlich
auch sehr zufrieden damit. Nur eine Sache hab ich bisher nie
hinbekommen: das dokumentieren von lokalen Variablen.
Ein kl. Beispiel:
1 | /**
|
2 | @ingroup test
|
3 | @var GlobaleVar
|
4 | @brief Eine globale Variable für Doxygen
|
5 | */
|
6 | unsigned int GlobaleVar = 0;
|
7 |
|
8 |
|
9 | /**
|
10 | @ingroup test
|
11 | @brief Eine tolle Rechnung
|
12 | @param ADC_Value Letzter Messwert des ADC
|
13 | @return Das Ergebnis einer hoch aufwändigen Rechnung...
|
14 | */
|
15 | unsigned int Calculate(unsigned int ADC_Value)
|
16 | {
|
17 |
|
18 | /** @brief Beschreibung von TempVar */
|
19 | unsigned char TempVar = 0;
|
20 | TempVar = ADC_Value + GlobaleVar;
|
21 | // mache noch irgendwas sinnvolles mit TempVar
|
22 | return TempVar;
|
23 | }
|
Das dokumentieren der globalen Variablen funktioniert in diesem Beispiel
tadellos. Das Doxygen-gerechte dokumentieren der lokalen Variable
TempVar klappt aber absolut nicht.
Bisher hab ich u.a. noch zusätzlich folgende Variante probiert, jeweils
innerhalb der Funktion:
1 | ///Beschreibung von TempVar
|
2 | unsigned char TempVar = 0;
|
3 |
|
4 |
|
5 | /** Beschreibung von TempVar */
|
6 | unsigned char TempVar = 0;
|
7 |
|
8 |
|
9 | /**
|
10 | @var TempVar
|
11 | @brief Beschreibung von TempVar
|
12 | */
|
13 | unsigned char TempVar = 0;
|
Nichts davon funktioniert. Wie macht ihr das? Wie beschreibt man lokale
Variablen Doxygen-gerecht?????
Vielen Dank für alle Antworten...
Gruß
Frank
