Hallo zusammen,
ich versuche gerade, mich in Doxygen einzuarbeiten. Ein paar Sachen
finde ich auf Anhieb gut. Andere sehr lästig.
Aus einer fünf Zeilen langen Struct-Definition wird z.B. eine ganze
Seite, bei der ich am Laptop sogar scrollen muss. Das gerenderte Bild
ist im Anhang.
1 | /** @brief Statusvariable 64-Bit-Differenzierer */
|
2 | typedef struct
|
3 | {
|
4 | int64_t lastValues[DERIVATIVE_N_VALUES]; /**< Letzte N Eingangswerte */
|
5 | }
|
6 | Fbctrl_Diff64State_t;
|
Gibt es eine Möglichkeit, struct deutlich kompakter darzustellen, dass
das erzeugte "Dokument" annähernd so übersichtlich wie der Quelltext
ist?
Bei den meisten structs wäre eine "detailed description" jedes einzelnen
Felds ja komplett überflüssig, und es würde reichen, die Beschreibung
direkt in die Aufzählung zu packen.