fix: コメント文の修正

KatLab-MiyazakiUniv · Jun 4, 2024 · fbdde40 · fbdde40
1 parent 826106e
commit fbdde40
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 7 deletions.
diff --git a/module/API/Controller.h b/module/API/Controller.h
@@ -11,7 +11,10 @@
 
 class Controller {
  public:
+  /** PWM値の上限 */
   static const int MOTOR_PWM_MAX = 100;
+
+  /** PWM値の下限 */
   static const int MOTOR_PWM_MIN = -100;
 
   /**
@@ -20,25 +23,25 @@ class Controller {
   Controller();
 
   /**
-   * タイヤのモータにPWM値をセット
+   * @brief タイヤのモータにPWM値をセット
    * @param pwm PWM値
    */
   void setRightMotorPwm(const int pwm);
   void setLeftMotorPwm(const int pwm);
 
   /**
-   * タイヤのモータを停止する
+   * @brief タイヤのモータを停止する
    */
   void stopMotor();
 
   /**
-   * アームのモータにPWM値をセット
+   * @brief アームのモータにPWM値をセット
    * @param pwm PWM値
    */
   void setArmMotorPwm(const int pwm);
 
   /**
-   * アームのモータを停止する
+   * @brief アームのモータを停止する
    */
   void stopArmMotor();
 
@@ -48,7 +51,7 @@ class Controller {
   ev3api::Motor armMotor;
 
   /**
-   * モータに設定するPWM値の制限
+   * @brief モータに設定するPWM値の制限
    * @param value 入力されたPWM値
    * @return 制限されたPWM値
    */

diff --git a/module/API/Timer.h b/module/API/Timer.h
@@ -18,13 +18,13 @@ class Timer {
   Timer();
 
   /**
-   * 自タスクスリープ（デフォルトは10ミリ秒）
+   * @brief 自タスクスリープ（デフォルトは10ミリ秒）
    * @param milliSec スリープ時間(ミリ秒)
    */
   void sleep(int milliSec = 10);
 
   /**
-   * 走行時間を取得
+   * @brief 走行時間を取得
    * @return 走行時間(ミリ秒)
    */
   int now();