better Doxygen documentation of icon()

This commit is contained in:
marschap
2008-12-21 14:07:20 +00:00
parent 55147836eb
commit 175e4c7b4f
12 changed files with 24 additions and 12 deletions
+2 -1
View File
@@ -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)
+2 -1
View File
@@ -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)
+2 -1
View File
@@ -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)
+2 -1
View File
@@ -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)
+2 -1
View File
@@ -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)
+2 -1
View File
@@ -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)
+2 -1
View File
@@ -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)
+2 -1
View File
@@ -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)
+2 -1
View File
@@ -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)
+2 -1
View File
@@ -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)
+2 -1
View File
@@ -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)
{
+2 -1
View File
@@ -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)