Parameterwerte mit Doxygen dokumentieren

OP #4525331 
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?
Antwort Zitieren Bearbeiten Thread verschieben Thread sperren Langsamer Modus Anmeldepflicht aktivieren Anpinnen Thread löschen Thread mit anderem zusammenführen Melden Danke 
#defines kann man auch einzeln dokumentieren.

1
/*@{*/

2
#define LCD_I2C_DEVICE    0x4E      /**< Change this to the address of your expander */

3
#define LCD_LINES      2          /**< Enter the number of lines of your display here */

4
#define LCD_COLS      16          /**< Enter the number of columns of your display here */

5
#define LCD_LINE_MODE       LCD_2LINE   /**< Enter line mode your display here */

6


7
#define LCD_LINE1      0x00      /**< This should be 0x00 on all displays */

8
#define LCD_LINE2      0x40      /**< Change this to the address for line 2 on your display */

9
#define LCD_LINE3      0x40      /**< Change this to the address for line 3 on your display */

10
#define LCD_LINE4      0x60      /**< Change this to the address for line 4 on your display */

11
/*@}*/


Beitrag "I2CLCD Library für HD44780 LCDs"
Antwort Zitieren Bearbeiten Löschen Melden Danke
Thread beobachten

Antwort schreiben

Eine eigene Frage? Dieser Thread ist über 10 Jahre alt. Stell sie in einem eigenen Thread – dort lesen mehr Leute mit, und sie wird öfter und schneller beantwortet.

Neuen Thread starten

Eine Lösung, Ergänzung oder Rückmeldung zu diesem Thread? Dann antworte hier.

Formatierung
  • [c]C-Code[/c]
  • [code]Code in anderen Sprachen, ASCII-Zeichnungen[/code]
  • [math]Formel in LaTeX-Syntax[/math]
  • [[Titel]] – Link zu einem Artikel
  • Verweis auf einen anderen Beitrag: Rechtsklick auf dessen Beitrags-ID (#8078628), „Adresse kopieren“, in den Text einfügen

Mehr zur Formatierung

Längeren Sourcecode als Anhang, nicht in den Text. JPG nur für Fotos und Scans; Zeichnungen und Screenshots als PNG oder GIF. Siehe Bildformate.

Dein Name und deine E-Mail-Adresse

Schon registriert? Anmelden

Wird nicht angezeigt. Wir schicken dir einen Link; sobald du damit bestätigst, erscheint dein Beitrag.

Mit dem Abschicken legst du einen kostenlosen Account an und erkennst die Nutzungsbedingungen und die Datenschutzerklärung an.