Diff: ExtendedServo.h

Revision:

5:8223f5a154e2

Parent:

3:198ec91cec19

Child:

6:8364e8639b4e

--- a/ExtendedServo.h	Tue Oct 14 16:15:11 2014 +0000
+++ b/ExtendedServo.h	Wed Oct 15 10:21:51 2014 +0000
@@ -3,17 +3,34 @@
  
 #include "PwmServo.h"
 
-/* 拡張サーボクラス */
+/**
+ * 拡張サーボクラス
+ * サーボに任意の原点、方向、角度の上下限を設定するクラス
+ * @author yosuke kirihata
+ */
 class ExtendedServo : public PwmServo
 {
   public:
-    //constructor
+    /**
+     * コンストラクタ
+     */
     ExtendedServo(PinName pin);
+    
+    /**
+     * コンストラクタ
+     */
     ExtendedServo(PinName pin, int upperLimit , int lowerLimit);
+    
+    /**
+     * コンストラクタ
+     */
     ExtendedServo(PinName pin, int upperLimitAngle ,int lowerLimitAngle,
                   int offsetAngle, bool isReverse);
-    //destructor
+    /**
+     * デストラクタ
+     */
     ~ExtendedServo();
+    
     //setter,getter
     void setOffsetAngle(int angle);
     int getOffsetAngle();
@@ -23,18 +40,45 @@
     int getUpperLimit();
     void setLowerLimit(int angle);
     int getLowerLimit();
-    //method
+    
+    /** 
+     * 角度変換
+     * @param angle 角度
+     * @return
+     */    
     int convertAngle(int angle);
+    
+    /** 
+     * 角度反転
+     * @param angle 角度
+     * @param isReverse 方向フラグ
+     * @return 
+     */    
     int reverseAngle(int angle, bool isReverse);
+    
+    /** 
+     * 角度設定
+     * @param angle 目標角度
+     * @return     
+     */    
     int roundAngle(int angle, int upperLimit, int lowerLimit);
+    
+    /** 
+     * 角度設定
+     * @param angle 目標角度
+     */    
     void setAngle(int angle);
+    
+    /** 
+     * 原点回帰
+     */        
     void backToStartPoint();
  
   private:
-    int mOffsetAngle;
-    bool mIsReverse;
-    int mUpperLimit;
-    int mLowerLimit;
+    int mOffsetAngle; /**　@brief 角度のオフセット値 */
+    bool mIsReverse;  /**　@brief 方向フラグ */
+    int mUpperLimit;  /**　@brief 角度上限値 */
+    int mLowerLimit;  /**　@brief 角度下限値 */
 };
  
 #endif /* __EXTENDEDSERVO_H__ */
\ No newline at end of file