mic: Adding doxygen comments and image from seeed wiki

Signed-off-by: John Van Drasek <john.r.van.drasek@intel.com>
This commit is contained in:
John Van Drasek 2015-04-14 15:13:17 -07:00
parent e9192d14c2
commit 2555aec888
2 changed files with 11 additions and 3 deletions

BIN
docs/images/mic.jpg Executable file

Binary file not shown.

After

Width:  |  Height:  |  Size: 46 KiB

View File

@ -36,16 +36,24 @@ struct thresholdContext {
namespace upm { namespace upm {
/** /**
* @brief analog microphone library * @brief Analog Microphone library
* @defgroup mic libupm-mic * @defgroup mic libupm-mic
* @ingroup seeed pwm sound
*/ */
/** /**
* @library libupm-mic
* @sensor mic
* @comname Analog Microphone
* @type sound
* @man seeed
* @web http://www.seeedstudio.com/wiki/Grove_-_Sound_Sensors
* @con pwm
*
* @brief C++ API for Microphone * @brief C++ API for Microphone
* *
* This file defines the Microphone Analog sensor * This file defines the Microphone Analog sensor
* *
* @ingroup mic pwm * @image html mic.jpg
* @snippet mic.cxx Interesting * @snippet mic.cxx Interesting
*/ */
class Microphone { class Microphone {