alexey.zholtikov/upm
1
0
Fork 0
mirror of https://github.com/eclipse/upm.git synced 2025-07-03 02:11:15 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: updated @param tags, added missing function descriptions, other minor changes

Browse Source 
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
Mihai Tudor Panu
2017-04-10 16:59:39 -07:00
parent 39df7fd10f
commit 3aef2ea70e
94 changed files with 327 additions and 222 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
src/ttp223/ttp223.h
View File

@ -75,15 +75,26 @@ void ttp223_close(ttp223_context dev);
upm_result_t ttp223_is_pressed(ttp223_context dev, bool* value);
/**
* Installs an interrupt service routine (ISR) to be called when
* the button is activated or deactivated.
*
* @param dev pointer to the sensor struct
* @param edge_level one of mraa_gpio_edge_t values
* @param isr pointer to a function to be called on interrupt
* @param arg pointer to an object to be supplied as an
* argument to the ISR.
* @result upm_result_t UPM success/error code
*/
upm_result_t ttp223_install_isr(ttp223_context dev,
mraa_gpio_edge_t edge_level,
void (*isr)(void *), void *arg);
/**
* Uninstall a previously installed interrupt handler
*
* @param dev pointer to the sensor struct
* @result upm_result_t UPM success/error code
*/
upm_result_t ttp223_uninstall_isr(ttp223_context);
upm_result_t ttp223_uninstall_isr(ttp223_context dev);
#endif /* TTP223_H_ */

2
src/ttp223/ttp223.hpp
View File

@ -91,7 +91,7 @@ class TTP223 {
* Installs an interrupt service routine (ISR) to be called when
* the button is activated or deactivated.
*
* @param fptr Pointer to a function to be called on interrupt
* @param isr Pointer to a function to be called on interrupt
* @param arg Pointer to an object to be supplied as an
* argument to the ISR.
*/