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

upm-c: added doxygen tags to generate documentation for C APIs

Browse Source 
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
Mihai Tudor Panu
2016-09-26 17:28:21 -07:00
parent 73719a6659
commit eb7a3ceac7
43 changed files with 265 additions and 356 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
src/a110x/a110x.h
View File

@ -33,34 +33,11 @@
#include "mraa/gpio.h"
/**
* @brief A110X Hall Effect library
* @defgroup a110x libupm-a110x
* @ingroup gpio electric robok
*/
/**
* @file a110x.h
* @library a110x
* @sensor a110x
* @comname A110X Hall Effect Sensor
* @altname Grove Hall Sensor
* @altid A1101, A1102, A1103, A1004, A1106
* @type electric
* @web http://www.allegromicro.com/en/Products/Magnetic-Digital-Position-Sensor-ICs/Hall-Effect-Unipolar-Switches/A1101-2-3-4-6.aspx
* @con gpio
* @kit robok
* @brief C API for the A110X Hall Effect sensors
*
* @brief API for the A110X Hall Effect sensors
*
* UPM module for the A110X (A1101, A1102, A1103, A1104, and A1106)
* Hall Effect sensors. It outputs a digital signal indicating
* whether it is detecting a magnetic field with south polarity
* perpendicular to the sensor element.
*
* @image html a110x.jpg
* An example showing a simple test for the presence of a field
* @snippet a110x.cxx Interesting
* An example demonstrating the use of an interrupt handler to count pulses
* @snippet a110x-intr.cxx Interesting
* @include a110x.c
*/
/**