alexey.zholtikov/upm
1
0
Fork 0
mirror of https://github.com/eclipse/upm.git synced 2025-07-05 11:21:12 +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

23
src/dfrorp/dfrorp.h
View File

@ -34,26 +34,11 @@ extern "C" {
#endif
/**
* @brief UPM C API for the DFRobot ORP (Oxidation/Reduction
* Potential) Sensor
* @file dfrorp.h
* @library dfrorp
* @brief C API for the DFRobot ORP (Oxidation/Reduction Potential) Sensor
*
* The driver was tested with the DFRobot ORP Analog Sensor.
*
* To calibrate:
*
* Disconnect the sensor probe (but leave the sensor interface board
* connected). Then run one of the examples while holding down the
* 'calibrate' button on the device. Read the ORP value reported
* (it should be fairly small).
*
* This value is what you should supply to
* dfrorp_set_orp_cal_offset(). Then reconnect the probe to the
* interface board and you should be ready to go.
*
* DO NOT press the calibrate button on the interface board while
* the probe is attached or you can permanently damage the probe.
*
* @snippet dfrorp.c Interesting
* @include dfrorp.c
*/
/**