Parameterwerte mit Doxygen dokumentieren

[Rolf M. (rmagnus)]

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?

[Bernd K. (prof7bit)]

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.

[Rolf M. (rmagnus)]

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.

[Clemens L. (c_l)]

Dann musst du halt die #define-Symbole dokumentieren, und in der 
\param-Beschreibung einen #Querverweis setzen.

[Falk B. (falk)]

#defines kann man auch einzeln dokumentieren.

/*@{*/
#define LCD_I2C_DEVICE    0x4E      /**< Change this to the address of your expander */
#define LCD_LINES      2          /**< Enter the number of lines of your display here */
#define LCD_COLS      16          /**< Enter the number of columns of your display here */
#define LCD_LINE_MODE       LCD_2LINE   /**< Enter line mode your display here */

#define LCD_LINE1      0x00      /**< This should be 0x00 on all displays */
#define LCD_LINE2      0x40      /**< Change this to the address for line 2 on your display */
#define LCD_LINE3      0x40      /**< Change this to the address for line 3 on your display */
#define LCD_LINE4      0x60      /**< Change this to the address for line 4 on your display */
/*@}*/

Beitrag "I2CLCD Library für HD44780 LCDs"