Hallo zusammen,
ich suche gerade, wie man Makro-Definitionen sinnvoll in Doxygen
einpflegt.
So sieht es momentan undoxydiert aus:
1 | /* Buffers:
|
2 | *
|
3 | * TEXTBUFFERSIZE_BYTES: Hilfspuffer fuer Textstrings
|
4 | * AUX_BUFFERSIZE_BYTES: Hilfspuffer fuer lokale Puffer mit MALLOC
|
5 | * MAX_BLOCK_NBYTES: Maximaler Speicherblock fuer LCD-Zwecke (z.B. Bitmaps im RAM)
|
6 | */
|
7 | #if defined( STM32F10x )
|
8 | #define MAX_BLOCK_NBYTES 2048
|
9 | #define AUX_BUFFERSIZE_BYTES 2048
|
10 | #define TEXTBUFFERSIZE_BYTES 100
|
11 |
|
12 | #elif defined( STM32F4XX )
|
13 | #define MAX_BLOCK_NBYTES 32768
|
14 | #define AUX_BUFFERSIZE_BYTES 8192
|
15 | #define TEXTBUFFERSIZE_BYTES 100
|
16 |
|
17 | #else
|
18 | /* Am PC-Prototypen Puffer vorsorglich eng einstellen, um Ueberlaufeffekte sichtbar zu
|
19 | machen */
|
20 | #define MAX_BLOCK_NBYTES 2048
|
21 | #define AUX_BUFFERSIZE_BYTES 2048
|
22 | #define TEXTBUFFERSIZE_BYTES 100
|
23 |
|
24 | #endif
|
"Besonderheit" ist hier, dass die Beschreibung für die Makros in allen
Fällen gleich ist, und nur die Werte unterschiedlich. Die Werte brauchen
in der DoXu auch gar nicht aufzutauchen.
Eine Google-Suche nach den unterschiedlichen Kombinationen aus "Doxygen"
und "Makros" schickt mich nur auf Stackoverflow im Kreis, die
eigentliche Dokumentation schweigt sich ja zu Makros beharrlich aus.
Da ich nicht annehme, dass dieser Anwendungsfall bei den
µC-Programmierern, die Doxygen benutzen, Seltenheit hat: Wie macht ihr
das?
