alexey.zholtikov/upm
1
0
Fork 0
mirror of https://github.com/eclipse/upm.git synced 2025-03-15 04:57:30 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

ttp223.h: adding doxygen tags

Browse Source 
Signed-off-by: John Van Drasek <john.r.van.drasek@intel.com>
This commit is contained in:
John Van Drasek 2015-03-20 16:26:22 -07:00
parent 816a3055f4
commit 7bb661d31b
1 changed files with 20 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
src/ttp223/ttp223.h
View File

@ -27,22 +27,33 @@
#include <mraa/gpio.h>
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.
*
* @defgroup ttp223 libupm-ttp223
* @ingroup seeed gpio touch
*/
/**
* @brief C++ API for TTP223 touch detector-based sensors,
* such as the Grove Touch sensor
* @library ttp223
* @sensor ttp223
* @comname Touch sensor
* @type touch
* @man seeed
* @web http://www.seeedstudio.com/depot/Grove-Touch-Sensor-p-747.html
* @con gpio
*
* 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
*
* 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.
*
* @ingroup ttp223 gpio
* @snippet ttp223.cxx Interesting
*/
class TTP223 {