diff --git a/clients/lcdproc/machine.h b/clients/lcdproc/machine.h index 1b9d329..b7618c8 100644 --- a/clients/lcdproc/machine.h +++ b/clients/lcdproc/machine.h @@ -15,7 +15,7 @@ #include "shared/LL.h" #ifndef LOADAVG_NSTATS -# define LOADAVG_NSTATS 3 /** size of loadavg[] parameter to getloadavg() */ +# define LOADAVG_NSTATS 3 /**< size of loadavg[] parameter to getloadavg() */ #endif #ifndef LOADAVG_1MIN diff --git a/server/drivers.c b/server/drivers.c index 6f0b388..c7914d4 100644 --- a/server/drivers.c +++ b/server/drivers.c @@ -1,5 +1,5 @@ /** \file drivers.c - * This code manages the lists of loaded drivers and does actions on all drivers. + * Manage the lists of loaded drivers and perform actions on all drivers. */ /* This file is part of LCDd, the lcdproc server. diff --git a/server/drivers/CFontz.c b/server/drivers/CFontz.c index 5bb19fb..6ce9919 100644 --- a/server/drivers/CFontz.c +++ b/server/drivers/CFontz.c @@ -102,7 +102,8 @@ static void CFontz_raw_chr(Driver *drvthis, int x, int y, unsigned char c); /** * Initialize the driver. * \param drvthis Pointer to driver structure. - * \return Information of success (0) or failure (non-0). + * \retval 0 Success. + * \retval <0 Error. */ MODULE_EXPORT int CFontz_init(Driver *drvthis) @@ -745,7 +746,7 @@ int do_init = 0; /** - * Get number of custom characters available. + * Get total number of custom characters available. * \param drvthis Pointer to driver structure. * \return Number of custom characters (always NUM_CCs). */ diff --git a/server/drivers/CFontz633.c b/server/drivers/CFontz633.c index e990949..9b7e682 100644 --- a/server/drivers/CFontz633.c +++ b/server/drivers/CFontz633.c @@ -129,7 +129,8 @@ static void CFontz633_hardware_clear (Driver *drvthis); /** * Initialize the driver. * \param drvthis Pointer to driver structure. - * \return Information of success (0) or failure (non-0). + * \retval 0 Success. + * \retval <0 Error. */ MODULE_EXPORT int CFontz633_init (Driver *drvthis) @@ -789,7 +790,7 @@ int do_init = 0; /** - * Get number of custom characters available. + * Get total number of custom characters available. * \param drvthis Pointer to driver structure. * \return Number of custom characters (always NUM_CCs). */ diff --git a/server/drivers/CFontzPacket.c b/server/drivers/CFontzPacket.c index 33a7384..94eb755 100644 --- a/server/drivers/CFontzPacket.c +++ b/server/drivers/CFontzPacket.c @@ -162,7 +162,8 @@ static void CFontzPacket_hardware_clear (Driver *drvthis); /** * Initialize the driver. * \param drvthis Pointer to driver structure. - * \return Information of success (0) or failure (non-0). + * \retval 0 Success. + * \retval <0 Error. */ MODULE_EXPORT int CFontzPacket_init (Driver *drvthis) @@ -956,7 +957,7 @@ int do_init = 0; /** - * Get number of custom characters available. + * Get total number of custom characters available. * \param drvthis Pointer to driver structure. * \return Number of custom characters (always NUM_CCs). */ diff --git a/server/drivers/CwLnx.c b/server/drivers/CwLnx.c index 641d15c..e1612c4 100644 --- a/server/drivers/CwLnx.c +++ b/server/drivers/CwLnx.c @@ -404,7 +404,8 @@ CwLnx_hidecursor(int fd) /** * Initialize the driver. * \param drvthis Pointer to driver structure. - * \return Information of success (0) or failure (non-0). + * \retval 0 Success. + * \retval <0 Error. */ MODULE_EXPORT int CwLnx_init(Driver *drvthis) @@ -945,7 +946,7 @@ CwLnx_num(Driver *drvthis, int x, int num) /** - * Get number of custom characters available. + * Get total number of custom characters available. * \param drvthis Pointer to driver structure. * \return Number of custom characters (always NUM_CCs). */ diff --git a/server/drivers/IOWarrior.c b/server/drivers/IOWarrior.c index 1e13d90..0b66b91 100644 --- a/server/drivers/IOWarrior.c +++ b/server/drivers/IOWarrior.c @@ -209,7 +209,8 @@ static int iowled_on_off(usb_dev_handle *udh,int type, unsigned int pattern) /** * Initialize the driver. * \param drvthis Pointer to driver structure. - * \return Information of success (0) or failure (non-0). + * \retval 0 Success. + * \retval <0 Error. */ MODULE_EXPORT int IOWarrior_init(Driver *drvthis) @@ -816,7 +817,7 @@ PrivateData *p = drvthis->private_data; /** - * Get number of custom characters available. + * Get total number of custom characters available. * \param drvthis Pointer to driver structure. * \return Number of custom characters (always NUM_CCs). */ diff --git a/server/drivers/MtxOrb.c b/server/drivers/MtxOrb.c index acd8eae..37cb0d9 100644 --- a/server/drivers/MtxOrb.c +++ b/server/drivers/MtxOrb.c @@ -180,7 +180,8 @@ MtxOrb_parse_keypad_setting (Driver *drvthis, char *keyname, char default_value) /** * Initialize the driver. * \param drvthis Pointer to driver structure. - * \return Information of success (0) or failure (non-0). + * \retval 0 Success. + * \retval <0 Error. */ MODULE_EXPORT int MtxOrb_init (Driver *drvthis) @@ -1166,7 +1167,7 @@ MtxOrb_num (Driver *drvthis, int x, int num) /** - * Get number of custom characters available. + * Get total number of custom characters available. * \param drvthis Pointer to driver structure. * \return Number of custom characters (always NUM_CCs). */ diff --git a/server/drivers/glk.c b/server/drivers/glk.c index 7921dd3..0025647 100644 --- a/server/drivers/glk.c +++ b/server/drivers/glk.c @@ -580,7 +580,7 @@ IOWarrior_num(Driver *drvthis, int x, int num) /** - * Get number of custom characters available. + * Get total number of custom characters available. * \param drvthis Pointer to driver structure. * \return Number of custom characters (always 0). */ diff --git a/server/drivers/hd44780.c b/server/drivers/hd44780.c index c612e7d..4b19a45 100644 --- a/server/drivers/hd44780.c +++ b/server/drivers/hd44780.c @@ -746,7 +746,7 @@ HD44780_num(Driver *drvthis, int x, int num) /** - * Get number of custom characters available. + * Get total number of custom characters available. * \param drvthis Pointer to driver structure. * \return Number of custom characters (always NUM_CCs). */ diff --git a/server/drivers/serialPOS.c b/server/drivers/serialPOS.c index f714254..88ba207 100644 --- a/server/drivers/serialPOS.c +++ b/server/drivers/serialPOS.c @@ -200,7 +200,8 @@ serialPOS_parse_keypad_setting (Driver *drvthis, char *keyname, char default_val /** * Initialize the driver. * \param drvthis Pointer to driver structure. - * \return Information of success (0) or failure (non-0). + * \retval 0 Success. + * \retval <0 Error. */ MODULE_EXPORT int serialPOS_init (Driver *drvthis) @@ -838,7 +839,7 @@ serialPOS_num (Driver *drvthis, int x, int num) #ifdef NOTUSED /** - * Get number of custom characters available. + * Get total number of custom characters available. * \param drvthis Pointer to driver structure. * \return Number of custom characters (always NUM_CCs). */ diff --git a/shared/configfile.h b/shared/configfile.h index 82af6dd..ccbe4c9 100644 --- a/shared/configfile.h +++ b/shared/configfile.h @@ -1,5 +1,5 @@ /** \file configfile.h - * Declares routines to read INI-file like files. + * Declare routines to read INI-file like files. */ /* This file is part of LCDd, the lcdproc server.