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

docs: final batch of header files reviewed

Browse Source 
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
VadimPopov
2015-08-10 18:53:31 +03:00
committed by Mihai Tudor Panu
parent 04edb9be04
commit 1fe9b9eb1d
53 changed files with 1182 additions and 1191 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
src/ttp223/ttp223.h
View File

@ -28,13 +28,7 @@
namespace upm {
/**
* @brief TTP223 touch detector sensor library
*
* This touch sensor detects when a finger is near the metallic pad
* by a change in capacitance. It can replace a more traditional push
* button. The touch sensor can still function when placed under a
* non-metallic surface like glass or plastic.
*
* @brief TTP223 Touch Detector Sensor library
* @defgroup ttp223 libupm-ttp223
* @ingroup seeed gpio touch
*/
@ -48,11 +42,11 @@ namespace upm {
* @web http://www.seeedstudio.com/depot/Grove-Touch-Sensor-p-747.html
* @con gpio
*
* @brief TTP223 Touch Detector sensor library
* @brief API for the TTP223 Touch Sensor
*
* This touch sensor detects when a finger is near the metallic pad
* by a change in capacitance. It can replace a more traditional push
* button. The touch sensor can still function when placed under a
* by the change in capacitance. It can replace a more traditional push
* button. The touch sensor can still function when placed under a
* non-metallic surface like glass or plastic.
*
* @image html ttp223.jpg
@ -61,9 +55,9 @@ namespace upm {
class TTP223 {
public:
/**
* TTP223 touch sensor constructor
* TTP223 constructor
*
* @param pin GPIO pin where sensor is connected
* @param pin GPIO pin where the sensor is connected
*/
TTP223(unsigned int pin);
@ -73,23 +67,23 @@ class TTP223 {
~TTP223();
/**
* Return name of this sensor
* Returns the name of this sensor
*
* @return the name of this sensor
* @return Name of this sensor
*/
std::string name();
/**
* Get value from GPIO pin
* Gets the value from the GPIO pin
*
* @return the value from the GPIO pin
* @return Value from the GPIO pin
*/
int value();
/**
* Returns whether or not the touch sensor is being touched
* Determines whether the touch sensor is being touched
*
* @return true if the touch sensor is being touched; false otherwise
* @return True if touched, false otherwise
*/
bool isPressed();