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

12
src/grovecollision/grovecollision.h
View File

@ -27,7 +27,7 @@
namespace upm {
/**
* @brief Grove Collision sensor library
* @brief Grove Collision Sensor library
* @defgroup grovecollision libupm-grovecollision
* @ingroup seeed gpio accelerometer
*/
@ -44,7 +44,7 @@ namespace upm {
*
* The Grove Collision Sensor can detect whether any
* collision movement or vibration happens.
* It will output a low pulse signal when vibration is detected.
* It outputs a low pulse signal when vibration is detected.
*
* @image html grovecollision.jpg
* @snippet grovecollision.cxx Interesting
@ -52,17 +52,17 @@ namespace upm {
class GroveCollision {
public:
/**
* Grove Collision Constructor
* Grove collision sensor constructor
*
* @param pin digital pin to use
* @param pin Digital pin to use
*/
GroveCollision(int pin);
/**
* Grove Collision Destructor
* GroveCollision destructor
*/
~GroveCollision();
/**
* @return bool returns whether something is colliding with sensor
* @return bool Defines whether something is colliding with sensor
*/
bool isColliding();