rotaryencoder: 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:03:33 -07:00
parent 6a315f817d
commit 3b4e9da7c6
2 changed files with 31 additions and 17 deletions

BIN
docs/images/rotaryencoder.jpg Executable file

Binary file not shown.

After

Width:  |  Height:  |  Size: 136 KiB

View File

@ -30,23 +30,37 @@
namespace upm {
/**
* @brief C++ API for the Grove Rotary Encoder
*
* UPM module for the Grove Rotary Encoder. A Rotary Encoder
* encodes a rotation signal into electronic pulses that can be used
* to measure rotation and direction. It is useful in cases where a
* rotary knob is required, but using a potentiometer is not
* desireable. A rotary encoder can turn a full 360 degrees+
* without a stop and does not place a resistive load on the
* circuit, as is the case with a potentiometer.
*
* This module maintains a position that is incremented or
* decremented according to the rotation on the encoder.
*
* @ingroup gpio
* @snippet rotaryencoder.cxx Interesting
*/
/**
* @brief Grove Rotary Encoder library
* @defgroup rotaryencoder libupm-rotaryencoder
* @ingroup seeed gpio other
*/
/**
* @library libupm-rotaryencoder
* @sensor rotaryencoder
* @comname Grove Rotary Encoder
* @type other
* @man seeed
* @web http://www.seeedstudio.com/wiki/Grove_-_Encoder
* @con gpio
* @kit gsk
*
* @brief C++ API for the Grove Rotary Encoder
*
* UPM module for the Grove Rotary Encoder. A Rotary Encoder
* encodes a rotation signal into electronic pulses that can be used
* to measure rotation and direction. It is useful in cases where a
* rotary knob is required, but using a potentiometer is not
* desirable. A rotary encoder can turn a full 360 degrees+
* without a stop and does not place a resistive load on the
* circuit, as is the case with a potentiometer.
*
* This module maintains a position that is incremented or
* decremented according to the rotation on the encoder.
*
* @image html rotaryencoder.jpg
* @snippet rotaryencoder.cxx Interesting
*/
class RotaryEncoder {
public:
/**