From 5c16dd44a7d54a0a45b005aee7c5ed19ab4e7372 Mon Sep 17 00:00:00 2001 From: John Van Drasek Date: Fri, 20 Mar 2015 15:46:00 -0700 Subject: [PATCH] yg1006: adding doxygen tags Signed-off-by: John Van Drasek --- src/yg1006/yg1006.h | 35 +++++++++++++++++++++++++---------- 1 file changed, 25 insertions(+), 10 deletions(-) diff --git a/src/yg1006/yg1006.h b/src/yg1006/yg1006.h index a3414c83..a35a3c40 100644 --- a/src/yg1006/yg1006.h +++ b/src/yg1006/yg1006.h @@ -27,16 +27,31 @@ #include namespace upm { - - /** - * @brief C++ API for the YG1006 flame sensor - * - * UPM module for the YG1006 flame sensor. It detects flame or any - * other light in the 760nm - 1100nm wavelength range. - * - * @ingroup gpio - * @snippet yg1006.cxx Interesting - */ + /** + * @brief Library for the YG1006 flame sensor + * + * UPM module for the YG1006 flame sensor. It detects flame or any + * other light in the 760nm - 1100nm wavelength range. + * + * @defgroup yg1006 libupm-yg1006 + * @ingroup seeed gpio light + */ + /** + * @library yg1006 + * @sensor yg1006 + * @comname flame sensor + * @type light + * @man seeed + * @web http://www.seeedstudio.com/wiki/Grove_-_Flame_Sensor + * @con gpio + * + * @brief C++ API for the YG1006 flame sensor + * + * UPM module for the YG1006 flame sensor. It detects flame or any + * other light in the 760nm - 1100nm wavelength range. + * + * @snippet yg1006.cxx Interesting + */ class YG1006 { public: /**