Browse Source

stepmotor.h: adding doxygen tags

Signed-off-by: John Van Drasek <john.r.van.drasek@intel.com>
John Van Drasek 10 years ago
parent
commit
49d5c2de34
1 changed files with 15 additions and 6 deletions
  1. 15
    6
      src/stepmotor/stepmotor.h

+ 15
- 6
src/stepmotor/stepmotor.h View File

@@ -40,18 +40,27 @@
40 40
 #define LOW                0
41 41
 
42 42
 namespace upm {
43
-
44 43
 /**
45
- * @brief Stepper motor library
44
+ * @brief C++ API for the Stepper motor library
45
+ *
46
+ *   This file defines the stepmotor C++ interface
47
+ *
46 48
  * @defgroup stepper libupm-stepper
49
+ * @ingroup seeed pwm gpio motor
47 50
  */
48
-
49 51
 /**
50
- * @brief C++ API for StepMotor Drivers
52
+ * @library stepper
53
+ * @sensor stepper
54
+ * @comname Stepper motor
55
+ * @type motor
56
+ * @man seeed
57
+ * @web http://www.seeedstudio.com/wiki/Grove_-_I2C_Motor_Driver_V1.3
58
+ * @con pwm gpio
51 59
  *
52
- * This file defines the stepmotor C++ interface for libstepmotor
60
+ * @brief C++ API for the Stepper motor library
61
+ * 
62
+ *   This file defines the stepmotor C++ interface
53 63
  *
54
- * @ingroup stepper pwm
55 64
  * @snippet stepmotor.cxx Interesting
56 65
  */
57 66
 class StepMotor {