stepmotor.h: adding doxygen tags

Signed-off-by: John Van Drasek <john.r.van.drasek@intel.com>
This commit is contained in:
John Van Drasek 2015-03-20 17:40:37 -07:00
parent 7f30553a51
commit 49d5c2de34

View File

@ -40,18 +40,27 @@
#define LOW 0
namespace upm {
/**
* @brief Stepper motor library
* @brief C++ API for the Stepper motor library
*
* This file defines the stepmotor C++ interface
*
* @defgroup stepper libupm-stepper
* @ingroup seeed pwm gpio motor
*/
/**
* @brief C++ API for StepMotor Drivers
* @library stepper
* @sensor stepper
* @comname Stepper motor
* @type motor
* @man seeed
* @web http://www.seeedstudio.com/wiki/Grove_-_I2C_Motor_Driver_V1.3
* @con pwm gpio
*
* This file defines the stepmotor C++ interface for libstepmotor
* @brief C++ API for the Stepper motor library
*
* This file defines the stepmotor C++ interface
*
* @ingroup stepper pwm
* @snippet stepmotor.cxx Interesting
*/
class StepMotor {