From 49d5c2de34249ac16da7cb6b1ccf0765948afb2a Mon Sep 17 00:00:00 2001 From: John Van Drasek Date: Fri, 20 Mar 2015 17:40:37 -0700 Subject: [PATCH] stepmotor.h: adding doxygen tags Signed-off-by: John Van Drasek --- src/stepmotor/stepmotor.h | 21 +++++++++++++++------ 1 file changed, 15 insertions(+), 6 deletions(-) diff --git a/src/stepmotor/stepmotor.h b/src/stepmotor/stepmotor.h index 44bba387..64757d94 100644 --- a/src/stepmotor/stepmotor.h +++ b/src/stepmotor/stepmotor.h @@ -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 {