mangavalk/lcdproc
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Doxygen-ize

Browse Source
This commit is contained in:
marschap
2008-12-21 12:57:46 +00:00
parent c9e3db4a8d
commit 065fb021fe
3 changed files with 46 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files
server/drivers/irmanin.c
+19 -19
View File
@@ -1,5 +1,5 @@
/** \file server/drivers/irmanin.c
* LCDd \c irman input driver fora the IrMan IR remote control.
* LCDd \c irman input driver for the IrMan IR remote control.
*/
/* irmanin.c - test/demo of LIBIR's to interface with lcdproc (LCDd) */
@@ -47,26 +47,20 @@ CodeMap codemap[] = {
{ NULL, NULL }
};
//////////////////////////////////////////////////////////////////////////
////////////////////// Base "class" to derive from ///////////////////////
//////////////////////////////////////////////////////////////////////////
/* vars for the server core */
MODULE_EXPORT char *api_version = API_VERSION;
MODULE_EXPORT int stay_in_foreground = 0;
MODULE_EXPORT int supports_multiple = 0;
MODULE_EXPORT char *symbol_prefix = "irmanin_";
//void sigterm(int sig)
//{
// ir_free_commands();
// ir_finish();
// raise(sig);
//}
////////////////////////////////////////////////////////////
// init() should set up any device-specific stuff, and
// point all the function pointers.
/**
* Initialize the driver.
* \param drvthis Pointer to driver structure.
* \retval 0 Success.
* \retval <0 Error.
*/
MODULE_EXPORT int
irmanin_init (Driver *drvthis)
{
@@ -141,6 +135,11 @@ irmanin_init (Driver *drvthis)
return 1; // return success
}
/**
* Close the driver (do necessary clean-up).
* \param drvthis Pointer to driver structure.
*/
MODULE_EXPORT void
irmanin_close (Driver *drvthis)
{
@@ -154,11 +153,12 @@ irmanin_close (Driver *drvthis)
ir_finish();
}
//////////////////////////////////////////////////////////////////////
// Tries to read a LCDproc character string from an input device...
//
// Return NULL for "nothing available".
//
/**
* Get key from the device.
* \param drvthis Pointer to driver structure.
* \return String representation of the key;
* \c NULL if nothing available / unmapped key.
*/
MODULE_EXPORT const char *
irmanin_get_key (Driver *drvthis)
{