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

docs: header files for sensors starting with [a] reviewed.

Browse Source 
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
VadimPopov
2015-08-07 20:33:46 +03:00
committed by Mihai Tudor Panu
parent de49bb0e42
commit 9db2d57de3
11 changed files with 359 additions and 328 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
src/a110x/a110x.h
View File

@ -63,32 +63,32 @@ namespace upm {
/**
* A110x digital sensor constructor
*
* @param pin digital pin to use
* @param pin Digital pin to use
*/
A110X(int pin);
/**
* A110X Destructor
* A110X destructor
*/
~A110X();
/**
* Determine whether a magnetic field of south polarity has been detected
* Determines whether a magnetic field of south polarity has been detected
*
* @return True if magnetic field detected
*/
bool magnetDetected();
/**
* Install an Interrupt Service Routine (ISR) to be called when
* the appropriate magnetic field is detected.
* Installs an interrupt service routine (ISR) to be called when
* the appropriate magnetic field is detected
*
* @param fptr function pointer to function to be called on interrupt
* @param arg pointer to an object that will be supplied as an
* arguement to the ISR.
* @param fptr Pointer to a function to be called on interrupt
* @param arg Pointer to an object to be supplied as an
* argument to the ISR.
*/
void installISR(void (*isr)(void *), void *arg);
/**
* Uninstall the previously installed Interrupt Service Routine (ISR)
* Uninstalls the previously installed ISR
*
*/
void uninstallISR();