hcsr04: updated header with tags

Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
Mihai Tudor Panu 2015-04-13 11:39:10 -07:00
parent 0963b5e140
commit e714b0eb24

View File

@ -36,18 +36,24 @@
#define TRIGGER_PULSE 10 #define TRIGGER_PULSE 10
namespace upm { namespace upm {
/** /**
* @brief HCSR04 ultrasonic sensor library * @brief HC-SR04 ultrasonic sensor library
* @defgroup hcsr04 libupm-hcsr04 * @defgroup hcsr04 libupm-hcsr04
* @ingroup generic gpio sound
*/ */
/** /**
* @library hcsr04
* @sensor hcsr04
* @comname HCSR04 Ultrasonic Sensor
* @type sound
* @man generic
* @con gpio
*
* @brief C++ API for HCSR04 (ultrasonic ranging module) component * @brief C++ API for HCSR04 (ultrasonic ranging module) component
* *
* This file defines the HCSR04 C++ interface for libhcsr04 * This file defines the HCSR04 C++ interface for libhcsr04
* *
* @ingroup hcsr04 gpio
* @snippet hcsr04.cxx Interesting * @snippet hcsr04.cxx Interesting
*/ */
class HCSR04 { class HCSR04 {