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

docs: more header files edited

Browse Source 
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
VadimPopov
2015-08-09 22:51:25 +03:00
committed by Mihai Tudor Panu
parent 55e8076988
commit 04edb9be04
68 changed files with 1172 additions and 1172 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
src/grovegsr/grovegsr.h
View File

@ -28,7 +28,7 @@
namespace upm {
/**
* @brief GroveGSR Galvanic Skin Response sensor library
* @brief Grove GSR Galvanic Skin Response Sensor library
* @defgroup grovegsr libupm-grovegsr
* @ingroup seeed analog electric
*/
@ -41,10 +41,10 @@ namespace upm {
* @man seeed
* @con analog
*
* @brief API for the GroveGSR Galvanic Skin Response Sensor
* @brief API for the Grove GSR Galvanic Skin Response Sensor
*
* Measure the electrical conductance of skin in order
* to measure strong emotional reaction.
* Measures the electrical conductance of skin
* to measure strong emotional reactions.
* In other words, it measures sweat on your fingers
* as an indicator of strong emotional reactions.
*
@ -54,25 +54,25 @@ namespace upm {
class GroveGSR {
public:
/**
* GroveGSR sensor constructor
* Grove GSR sensor constructor
*
* @param pin analog pin to use
* @param pin Analog pin to use
*/
GroveGSR(int pin);
/**
* GroveGSR Destructor
* GroveGSR destructor
*/
~GroveGSR();
/**
* Calibrate the GroveGSR Sensor
* Calibrates the Grove GSR sensor
*/
void calibrate();
/**
* Measure the electrical conductance of the skin from the sensor
* Gets the electrical conductance of the skin from the sensor
*
* @return the electrical conductance of the skin
* @return Electrical conductance of the skin
*/
int value();