make Doxygen comments a bit easier to read

This commit is contained in:
marschap
2008-12-21 17:13:26 +00:00
parent cf92e1248e
commit a273c98182
3 changed files with 41 additions and 37 deletions
+3 -2
View File
@@ -104,7 +104,7 @@ Different implementations of (n)curses available on:
#define DEFAULT_BACKGROUND_COLOR COLOR_BLUE #define DEFAULT_BACKGROUND_COLOR COLOR_BLUE
/** private data structure for the \c curses driver */ /** private data for the \c curses driver */
typedef struct curses_private_data { typedef struct curses_private_data {
WINDOW *win; WINDOW *win;
@@ -625,7 +625,8 @@ curses_flush (Driver *drvthis)
/** /**
* Handle input from keyboard. * Handle input from keyboard.
* \param drvthis Pointer to driver structure. * \param drvthis Pointer to driver structure.
* \return String representation of the key. * \return String representation of the key;
* \c NULL if nothing available / unmapped key.
*/ */
MODULE_EXPORT const char * MODULE_EXPORT const char *
curses_get_key (Driver *drvthis) curses_get_key (Driver *drvthis)
+11 -9
View File
@@ -47,15 +47,16 @@
#define DEFAULT_OFFBRIGHTNESS 250 #define DEFAULT_OFFBRIGHTNESS 250
/** private data for the \c debug driver */
typedef struct debug_private_data { typedef struct debug_private_data {
char *framebuf; char *framebuf; /**< frame buffer */
int width; int width; /**< display width in characters */
int height; int height; /**< display height in characters */
int cellwidth; int cellwidth; /**< character cell width */
int cellheight; int cellheight; /**< character cell height */
int contrast; int contrast; /**< current contrast */
int brightness; int brightness; /**< current brightness (for backlight on) */
int offbrightness; int offbrightness; /**< current brightness (for backlight off) */
} PrivateData; } PrivateData;
@@ -485,7 +486,8 @@ debug_backlight (Driver *drvthis, int on)
/** /**
* Handle input from keyboard. * Handle input from keyboard.
* \param drvthis Pointer to driver structure. * \param drvthis Pointer to driver structure.
* \return String representation of the key. * \return String representation of the key;
* \c NULL if nothing available / unmapped key
*/ */
MODULE_EXPORT const char * MODULE_EXPORT const char *
debug_get_key (Driver *drvthis) debug_get_key (Driver *drvthis)
+6 -5
View File
@@ -37,11 +37,11 @@
//#include "drv_base.h" //#include "drv_base.h"
/* private data structure for the \c text driver */ /** private data for the \c text driver */
typedef struct text_private_data { typedef struct text_private_data {
int width; int width; /**< display width in characters */
int height; int height; /**< display height in characters */
char *framebuf; char *framebuf; /**< fram buffer */
} PrivateData; } PrivateData;
@@ -141,8 +141,9 @@ text_width (Driver *drvthis)
/** /**
* Clear the screen. * Return the display height in characters.
* \param drvthis Pointer to driver structure. * \param drvthis Pointer to driver structure.
* \return Number of characters the display is high.
*/ */
MODULE_EXPORT int MODULE_EXPORT int
text_height (Driver *drvthis) text_height (Driver *drvthis)