mirror of
https://github.com/eclipse/upm.git
synced 2025-03-24 01:10:22 +03:00
ttp223.h: adding doxygen tags
Signed-off-by: John Van Drasek <john.r.van.drasek@intel.com>
This commit is contained in:
parent
816a3055f4
commit
7bb661d31b
@ -27,22 +27,33 @@
|
|||||||
#include <mraa/gpio.h>
|
#include <mraa/gpio.h>
|
||||||
|
|
||||||
namespace upm {
|
namespace upm {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief TTP223 Touch Detector sensor library
|
* @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
|
* @defgroup ttp223 libupm-ttp223
|
||||||
|
* @ingroup seeed gpio touch
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief C++ API for TTP223 touch detector-based sensors,
|
* @library ttp223
|
||||||
* such as the Grove Touch sensor
|
* @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
|
* @brief TTP223 Touch Detector sensor library
|
||||||
* by a change in capacitance. It can replace a more traditional push
|
*
|
||||||
* button. The touch sensor can still function when placed under a
|
* This touch sensor detects when a finger is near the metallic pad
|
||||||
* non-metallic surface like glass or plastic.
|
* 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
|
* @snippet ttp223.cxx Interesting
|
||||||
*/
|
*/
|
||||||
class TTP223 {
|
class TTP223 {
|
||||||
|
Loading…
x
Reference in New Issue
Block a user