Hallo zusammen, ich dokumentiere eine API mit Doxygen. Jetzt kann man dort mit \retval ja sehr schön verschiedene Returnwerte, z.B. Fehlercodes dokumentieren. Für Parameterwerte finde ich aber nichts vergleichbares. Ich kann zwar mit \param jeden Parameter dokumentieren, aber ich habe für einen der Parameter auch verschiedene benannte Werte, die ich einzeln dokumentieren möchte, genau wie die Returnwerte. Es scheint aber kein \paramval oder sowas zu geben, und ich finde keinen Weg, das ähnlich schön hinzubekommen. Hat hier jemand eine Idee, wie man das macht?
Rolf M. schrieb: > aber ich habe > für einen der Parameter auch verschiedene benannte Werte Also ein Enum. Ich würde das dort dokumentieren wo dieses Enum definiert ist.
Bernd K. schrieb: > Also ein Enum. Nein, ein int mit per #define benannten Werten. Mag man nun mögen oder auch nicht, aber kann nicht geändert werden.
Dann musst du halt die #define-Symbole dokumentieren, und in der \param-Beschreibung einen #Querverweis setzen.
#defines kann man auch einzeln dokumentieren.
1 | |
2 | |
3 | |
4 | |
5 | |
6 | |
7 | |
8 | |
9 | |
10 | |
11 | |
Beitrag "I2CLCD Library für HD44780 LCDs"
Antwort schreiben
Bitte melde dich an, um einen Beitrag zu schreiben.