From 175e4c7b4f80627870121370339a0d573d68f2b1 Mon Sep 17 00:00:00 2001 From: marschap Date: Sun, 21 Dec 2008 14:07:20 +0000 Subject: [PATCH] better Doxygen documentation of icon() --- server/drivers/CFontz.c | 3 ++- server/drivers/CFontz633.c | 3 ++- server/drivers/CFontzPacket.c | 3 ++- server/drivers/CwLnx.c | 3 ++- server/drivers/IOWarrior.c | 3 ++- server/drivers/MtxOrb.c | 3 ++- server/drivers/NoritakeVFD.c | 3 ++- server/drivers/curses_drv.c | 3 ++- server/drivers/debug.c | 3 ++- server/drivers/hd44780.c | 3 ++- server/drivers/imon.c | 3 ++- server/drivers/ula200.c | 3 ++- 12 files changed, 24 insertions(+), 12 deletions(-) diff --git a/server/drivers/CFontz.c b/server/drivers/CFontz.c index fe2f004..127cc20 100644 --- a/server/drivers/CFontz.c +++ b/server/drivers/CFontz.c @@ -801,7 +801,8 @@ CFontz_set_char(Driver *drvthis, int n, unsigned char *dat) * \param x Horizontal character position (column). * \param y Vertical character position (row). * \param icon synbolic value representing the icon. - * \return Information whether the icon is handled here or needs to be handled by the server core. + * \retval 0 Icon has been successfully defined/written. + * \retval <0 Server core shall define/write the icon. */ MODULE_EXPORT int CFontz_icon(Driver *drvthis, int x, int y, int icon) diff --git a/server/drivers/CFontz633.c b/server/drivers/CFontz633.c index 64c117a..02f28c9 100644 --- a/server/drivers/CFontz633.c +++ b/server/drivers/CFontz633.c @@ -845,7 +845,8 @@ CFontz633_set_char (Driver *drvthis, int n, unsigned char *dat) * \param x Horizontal character position (column). * \param y Vertical character position (row). * \param icon synbolic value representing the icon. - * \return Information whether the icon is handled here or needs to be handled by the server core. + * \retval 0 Icon has been successfully defined/written. + * \retval <0 Server core shall define/write the icon. */ MODULE_EXPORT int CFontz633_icon (Driver *drvthis, int x, int y, int icon) diff --git a/server/drivers/CFontzPacket.c b/server/drivers/CFontzPacket.c index 36a57d0..ee74410 100644 --- a/server/drivers/CFontzPacket.c +++ b/server/drivers/CFontzPacket.c @@ -1013,7 +1013,8 @@ CFontzPacket_set_char (Driver *drvthis, int n, unsigned char *dat) * \param x Horizontal character position (column). * \param y Vertical character position (row). * \param icon synbolic value representing the icon. - * \return Information whether the icon is handled here or needs to be handled by the server core. + * \retval 0 Icon has been successfully defined/written. + * \retval <0 Server core shall define/write the icon. */ MODULE_EXPORT int CFontzPacket_icon (Driver *drvthis, int x, int y, int icon) diff --git a/server/drivers/CwLnx.c b/server/drivers/CwLnx.c index de8e2fb..13d0f0e 100644 --- a/server/drivers/CwLnx.c +++ b/server/drivers/CwLnx.c @@ -1143,7 +1143,8 @@ CwLnx_set_char_unrestricted(Driver *drvthis, int n, unsigned char *dat) * \param x Horizontal character position (column). * \param y Vertical character position (row). * \param icon synbolic value representing the icon. - * \return Information whether the icon is handled here or needs to be handled by the server core. + * \retval 0 Icon has been successfully defined/written. + * \retval <0 Server core shall define/write the icon. */ MODULE_EXPORT int CwLnx_icon(Driver *drvthis, int x, int y, int icon) diff --git a/server/drivers/IOWarrior.c b/server/drivers/IOWarrior.c index 9dd3887..d11b181 100644 --- a/server/drivers/IOWarrior.c +++ b/server/drivers/IOWarrior.c @@ -894,7 +894,8 @@ int row; * \param x Horizontal character position (column). * \param y Vertical character position (row). * \param icon synbolic value representing the icon. - * \return Information whether the icon is handled here or needs to be handled by the server core. + * \retval 0 Icon has been successfully defined/written. + * \retval <0 Server core shall define/write the icon. */ MODULE_EXPORT int IOWarrior_icon(Driver *drvthis, int x, int y, int icon) diff --git a/server/drivers/MtxOrb.c b/server/drivers/MtxOrb.c index 2a6df4f..5841ba5 100644 --- a/server/drivers/MtxOrb.c +++ b/server/drivers/MtxOrb.c @@ -1220,7 +1220,8 @@ MtxOrb_set_char (Driver *drvthis, int n, unsigned char *dat) * \param x Horizontal character position (column). * \param y Vertical character position (row). * \param icon synbolic value representing the icon. - * \return Information whether the icon is handled here or needs to be handled by the server core. + * \retval 0 Icon has been successfully defined/written. + * \retval <0 Server core shall define/write the icon. */ MODULE_EXPORT int MtxOrb_icon (Driver *drvthis, int x, int y, int icon) diff --git a/server/drivers/NoritakeVFD.c b/server/drivers/NoritakeVFD.c index e13e6fb..0124d71 100644 --- a/server/drivers/NoritakeVFD.c +++ b/server/drivers/NoritakeVFD.c @@ -594,7 +594,8 @@ int do_init = 0; * \param x Horizontal character position (column). * \param y Vertical character position (row). * \param icon synbolic value representing the icon. - * \return Information whether the icon is handled here or needs to be handled by the server core. + * \retval 0 Icon has been successfully defined/written. + * \retval <0 Server core shall define/write the icon. */ MODULE_EXPORT int NoritakeVFD_icon (Driver *drvthis, int x, int y, int icon) diff --git a/server/drivers/curses_drv.c b/server/drivers/curses_drv.c index 23a7e39..e985bcc 100644 --- a/server/drivers/curses_drv.c +++ b/server/drivers/curses_drv.c @@ -556,7 +556,8 @@ curses_hbar (Driver *drvthis, int x, int y, int len, int promille, int options) * \param x Horizontal character position (column). * \param y Vertical character position (row). * \param icon synbolic value representing the icon. - * \return Information whether the icon is handled here or needs to be handled by the server core. + * \retval 0 Icon has been successfully defined/written. + * \retval <0 Server core shall define/write the icon. */ MODULE_EXPORT int curses_icon (Driver *drvthis, int x, int y, int icon) diff --git a/server/drivers/debug.c b/server/drivers/debug.c index 47d5c82..9fac935 100644 --- a/server/drivers/debug.c +++ b/server/drivers/debug.c @@ -365,7 +365,8 @@ debug_num (Driver *drvthis, int x, int num) * \param x Horizontal character position (column). * \param y Vertical character position (row). * \param icon synbolic value representing the icon. - * \return Information whether the icon is handled here or needs to be handled by the server core. + * \retval 0 Icon has been successfully defined/written. + * \retval <0 Server core shall define/write the icon. */ MODULE_EXPORT int debug_icon (Driver *drvthis, int x, int y, int icon) diff --git a/server/drivers/hd44780.c b/server/drivers/hd44780.c index 2ff156b..a24172a 100644 --- a/server/drivers/hd44780.c +++ b/server/drivers/hd44780.c @@ -1044,7 +1044,8 @@ HD44780_set_char(Driver *drvthis, int n, unsigned char *dat) * \param x Horizontal character position (column). * \param y Vertical character position (row). * \param icon synbolic value representing the icon. - * \return Information whether the icon is handled here or needs to be handled by the server core. + * \retval 0 Icon has been successfully defined/written. + * \retval <0 Server core shall define/write the icon. */ MODULE_EXPORT int HD44780_icon(Driver *drvthis, int x, int y, int icon) diff --git a/server/drivers/imon.c b/server/drivers/imon.c index 893dbe1..d711468 100644 --- a/server/drivers/imon.c +++ b/server/drivers/imon.c @@ -285,7 +285,8 @@ MODULE_EXPORT void imon_chr (Driver *drvthis, int x, int y, char c) * \param x Horizontal character position (column). * \param y Vertical character position (row). * \param icon synbolic value representing the icon. - * \return Information whether the icon is handled here or needs to be handled by the server core. + * \retval 0 Icon has been successfully defined/written. + * \retval <0 Server core shall define/write the icon. */ MODULE_EXPORT int imon_icon (Driver *drvthis, int x, int y, int icon) { diff --git a/server/drivers/ula200.c b/server/drivers/ula200.c index baa1adb..5e27219 100644 --- a/server/drivers/ula200.c +++ b/server/drivers/ula200.c @@ -926,7 +926,8 @@ ula200_flush(Driver *drvthis) * \param x Horizontal character position (column). * \param y Vertical character position (row). * \param icon synbolic value representing the icon. - * \return Information whether the icon is handled here or needs to be handled by the server core. + * \retval 0 Icon has been successfully defined/written. + * \retval <0 Server core shall define/write the icon. */ MODULE_EXPORT int ula200_icon (Driver *drvthis, int x, int y, int icon)