rfr359f: 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 12:12:03 -07:00
parent 3b4e9da7c6
commit 3707e359f4
2 changed files with 14 additions and 1 deletions

BIN
docs/images/rfr359f.jpg Executable file

Binary file not shown.

After

Width:  |  Height:  |  Size: 61 KiB

View File

@ -29,13 +29,26 @@
namespace upm {
/**
* @brief Grove Distance Interrupter library
* @defgroup rfr359f libupm-rfr359f
* @ingroup seeed gpio light
*/
/**
* @library libupm-rfr359f
* @sensor rfr359f
* @comname Grove Distance Interrupter
* @type light
* @man seeed
* @web http://www.seeedstudio.com/wiki/Grove_-_IR_Distance_Interrupt
* @con gpio
*
* @brief C++ API for the RFR359F based Grove Distance Interrupter.
*
* UPM module for the Grove Distance Interrupter. The sensitivity
* can be adjusted with the potentiometer on the sensor module. It
* has a range of approximately 4 inches and a fast response time.
*
* @ingroup grove gpio
* @image html rfr359f.jpg
* @snippet rfr359f.cxx Interesting
*/
class RFR359F {