make Doxygen comments a bit easier to read
This commit is contained in:
@@ -104,7 +104,7 @@ Different implementations of (n)curses available on:
|
||||
#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 {
|
||||
WINDOW *win;
|
||||
|
||||
@@ -625,7 +625,8 @@ curses_flush (Driver *drvthis)
|
||||
/**
|
||||
* Handle input from keyboard.
|
||||
* \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 *
|
||||
curses_get_key (Driver *drvthis)
|
||||
|
||||
+11
-9
@@ -47,15 +47,16 @@
|
||||
#define DEFAULT_OFFBRIGHTNESS 250
|
||||
|
||||
|
||||
/** private data for the \c debug driver */
|
||||
typedef struct debug_private_data {
|
||||
char *framebuf;
|
||||
int width;
|
||||
int height;
|
||||
int cellwidth;
|
||||
int cellheight;
|
||||
int contrast;
|
||||
int brightness;
|
||||
int offbrightness;
|
||||
char *framebuf; /**< frame buffer */
|
||||
int width; /**< display width in characters */
|
||||
int height; /**< display height in characters */
|
||||
int cellwidth; /**< character cell width */
|
||||
int cellheight; /**< character cell height */
|
||||
int contrast; /**< current contrast */
|
||||
int brightness; /**< current brightness (for backlight on) */
|
||||
int offbrightness; /**< current brightness (for backlight off) */
|
||||
} PrivateData;
|
||||
|
||||
|
||||
@@ -485,7 +486,8 @@ debug_backlight (Driver *drvthis, int on)
|
||||
/**
|
||||
* Handle input from keyboard.
|
||||
* \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 *
|
||||
debug_get_key (Driver *drvthis)
|
||||
|
||||
@@ -37,11 +37,11 @@
|
||||
//#include "drv_base.h"
|
||||
|
||||
|
||||
/* private data structure for the \c text driver */
|
||||
/** private data for the \c text driver */
|
||||
typedef struct text_private_data {
|
||||
int width;
|
||||
int height;
|
||||
char *framebuf;
|
||||
int width; /**< display width in characters */
|
||||
int height; /**< display height in characters */
|
||||
char *framebuf; /**< fram buffer */
|
||||
} PrivateData;
|
||||
|
||||
|
||||
@@ -141,8 +141,9 @@ text_width (Driver *drvthis)
|
||||
|
||||
|
||||
/**
|
||||
* Clear the screen.
|
||||
* Return the display height in characters.
|
||||
* \param drvthis Pointer to driver structure.
|
||||
* \return Number of characters the display is high.
|
||||
*/
|
||||
MODULE_EXPORT int
|
||||
text_height (Driver *drvthis)
|
||||
|
||||
Reference in New Issue
Block a user