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

16
src/grovelinefinder/grovelinefinder.h
View File

@ -28,7 +28,7 @@
namespace upm {
/**
* @brief Grove Line Finder sensor library
* @brief Grove Line Finder Sensor library
* @defgroup grovelinefinder libupm-grovelinefinder
* @ingroup seeed gpio color robok
*/
@ -42,7 +42,7 @@ namespace upm {
* @con gpio
* @kit robok
*
* @brief API for the Grove Line Finder sensor
* @brief API for the Grove Line Finder Sensor
*
* UPM module for the Grove Line Finder sensor. It outputs a
* digital signal indicating whether it is detecting black on a
@ -56,23 +56,23 @@ namespace upm {
/**
* Grove Line Finder digital sensor constructor
*
* @param pin digital pin to use
* @param pin Digital pin to use
*/
GroveLineFinder(int pin);
/**
* GroveLineFinder Destructor
* GroveLineFinder destructor
*/
~GroveLineFinder();
/**
* Determine whether white has been detected
* Determines whether white has been detected
*
* @return True if white is being detected
* @return True if white is detected
*/
bool whiteDetected();
/**
* Determine whether black has been detected
* Determines whether black has been detected
*
* @return True if black is being detected
* @return True if black is detected
*/
bool blackDetected();