extend Doxygen description of input method

This commit is contained in:
marschap
2008-12-21 12:34:49 +00:00
parent 4a3274442d
commit c9e3db4a8d
7 changed files with 19 additions and 13 deletions
+3 -2
View File
@@ -451,9 +451,10 @@ CFontz633_flush (Driver *drvthis)
/**
* Get next key from the KeyRing.
* Get key from the device.
* \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 *
CFontz633_get_key (Driver *drvthis)
+3 -2
View File
@@ -563,9 +563,10 @@ CFontzPacket_flush (Driver *drvthis)
/**
* Get next key from the KeyRing.
* Get key from the device.
* \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 *
CFontzPacket_get_key (Driver *drvthis)
+3 -2
View File
@@ -1384,9 +1384,10 @@ CwLnx_string(Driver *drvthis, int x, int y, const char string[])
/**
* Get next key from the KeyRing.
* Get key from the device.
* \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 *
CwLnx_get_key(Driver *drvthis)
+2 -1
View File
@@ -1427,7 +1427,8 @@ MtxOrb_cursor (Driver *drvthis, int x, int y, int state)
/**
* Get key from the LCD/VFD.
* \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.
*
* \todo Recover the code for I2C connectivity to MtxOrb
* and don't query the LCD if it does not support keypad.
+3 -2
View File
@@ -1219,9 +1219,10 @@ HD44780_icon(Driver *drvthis, int x, int y, int icon)
/**
* Get next key from the key panel connected to the display.
* Get key from the key panel connected to the display.
* \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 *
HD44780_get_key(Driver *drvthis)
+2 -2
View File
@@ -928,9 +928,9 @@ serialPOS_cursor (Driver *drvthis, int x, int y, int state)
/**
* Get key from a pass-through port of the POS display.
* \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 *
serialPOS_get_key (Driver *drvthis)
{
+3 -2
View File
@@ -971,9 +971,10 @@ ula200_icon (Driver *drvthis, int x, int y, int icon)
/**
* Get next key from the KeyRing.
* Get key from the device.
* \param drvthis Pointer to driver structure.
* \return String representation of the key.
* \return String representation of the key;
* \c NULL for nothing available / unmapped key.
*/
MODULE_EXPORT const char *
ula200_get_key (Driver *drvthis)