Doxygenコメントを追加、修正 #22

include/ssr/AnalogIn.hpp

@@ -1,35 +1,55 @@
+/**
+ * @file AnalogIn.hpp
+ * @author H1rono (hronok66@gmail.com)
+ * @brief アナログ入力ピンを扱う型Output
+ * @version 0.1
+ * @copyright Copyright (c) 2022 ssr2022-saka-maza
+ */
+
 #pragma once
 
 #ifndef SSR_ANALOG_IN_HPP
+
+/**
+ * @brief ssr/AnalogIn.hppがインクルードされていることを示すdefine
+ */
 #define SSR_ANALOG_IN_HPP
 
 #include <Arduino.h>
 #include "ssr/PinType.hpp"
 #include "ssr/Input.hpp"
 
-// このライブラリが使う名前空間
+/**
+ * @brief ssrライブラリが使う名前空間
+ */
 namespace ssr {
-
-// アナログ入力ピンを扱う
-class AnalogIn : public Input<uint16_t> {
-public:
-    // 接続ピン
-    const PinType pin;
-
     /**
-     * 初期化子
-     * @param PinType pin 接続ピン
+     * @brief アナログ入力ピンを扱う型
      */
-    AnalogIn(PinType pin);
-    // ピンの初期設定。全体のsetup()内でこれを呼び出すこと
-    void begin();
-    /**
-     * 接続したピンの値を読む
-     * @return uint16_t 読んだ値
-     */
-    uint16_t read() override;
-};
+    class AnalogIn : public Input<uint16_t> {
+    public:
+        /**
+         * @brief 接続ピン
+         */
+        const PinType pin;
+
+        /**
+         * @brief 初期化子
+         * @param pin ssr::PinType 接続ピン
+         */
+        AnalogIn(PinType pin);
+
+        /**
+         * @brief ピンの初期設定。全体のsetup()内でこれを呼び出すこと
+         */
+        void begin();
 
-}
+        /**
+         * @brief 接続したピンの値を読む
+         * @return uint16_t 読んだ値
+         */
+        uint16_t read() override;
+    }; // class AnalogIn
+} // namespace ssr
 
 #endif /* SSR_ANALOG_IN_HPP */

include/ssr/AnalogOut.hpp

@@ -1,56 +1,74 @@
+/**
+ * @file AnalogOut.hpp
+ * @author H1rono (hronok66@gmail.com)
+ * @brief アナログ出力ピンを扱う型AnalogOut
+ * @version 0.1
+ * @copyright Copyright (c) 2022 ssr2022-saka-maza
+ */
+
 #pragma once
 
 #ifndef SSR_ANALOG_OUT_HPP
+
+/**
+ * @brief ssr/AnalogOut.hppがインクルードされていることを示すdefine
+ */
 #define SSR_ANALOG_OUT_HPP
 
 #include <Arduino.h>
 #include "ssr/PinType.hpp"
 #include "ssr/Output.hpp"
 
-// このライブラリが使う名前空間
+/**
+ * @brief ssrライブラリが使う名前空間
+ */
 namespace ssr {
-
-// アナログ出力ピンを扱う
-class AnalogOut : public Output<uint16_t> {
-private:
-    // ピンに出力した値
-    uint16_t _value;
-
-public:
-    // 接続ピン
-    const PinType pin;
-
     /**
-     * 初期化子
-     * @param PinType pin 接続ピン
+     * @brief アナログ出力ピンを扱う型
      */
-    AnalogOut(PinType pin);
+    class AnalogOut : public Output<uint16_t> {
+    private:
+        /**
+         * @brief 最後にピンに出力した値
+         */
+        uint16_t _value;
 
-    /**
-     * ピンの初期設定。全体のsetup()内でこれを呼び出すこと
-     * @param uint16_t value 初期値。デフォルトは0
-     */
-    void begin(uint16_t value = 0);
+    public:
+        /**
+         * @brief 接続するピン
+         */
+        const PinType pin;
 
-    /**
-     * 値を出力する
-     * @param uint16_t value 出力値。範囲は0~255
-     */
-    void setValue(uint16_t value);
+        /**
+         * @brief 初期化子
+         * @param pin ssr::PinType 接続ピン
+         */
+        AnalogOut(PinType pin);
 
-    /**
-     * 出力した値を得る
-     * @return 最後に出力した値
-     */
-    uint16_t getValue();
+        /**
+         * @brief ピンの初期設定。全体のsetup()内でこれを呼び出すこと
+         * @param value uint16_t 初期値。デフォルトは0
+         */
+        void begin(uint16_t value = 0);
 
-    /**
-     * 値を出力する
-     * @param uint16_t value 出力する値
-     */
-    void write(uint16_t value) override;
-};
+        /**
+         * @brief 値を出力する
+         * @param value uint16_t 出力値。範囲は0~255
+         */
+        void setValue(uint16_t value);
+
+        /**
+         * @brief 出力した値を得る
+         * @return 最後に出力した値
+         */
+        uint16_t getValue();
 
-}
+        /**
+         * @brief 値を出力する
+         * @param value uint16_t 出力する値
+         */
+        void write(uint16_t value) override;
+    }; // class AnalogOut
+} // namespace ssr
 
-#endif /* SSR_ANALOG_OUT_HPP */
+#endif /* SSR_ANALOG_OUT_HPP */

include/ssr/DigitalIn.hpp

@@ -1,35 +1,55 @@
+/**
+ * @file DigitalIn.hpp
+ * @author H1rono (hronok66@gmail.com)
+ * @brief デジタル入力ピンを扱う型DigitalIn
+ * @version 0.1
+ * @copyright Copyright (c) 2022 ssr2022-saka-maza
+ */
+
 #pragma once
 
 #ifndef SSR_DIGITAL_IN_HPP
+
+/**
+ * @brief ssr/DigitalIn.hppがインクルードされていることを示すdefine
+ */
 #define SSR_DIGITAL_IN_HPP
 
 #include <Arduino.h>
 #include "ssr/PinType.hpp"
 #include "ssr/Input.hpp"
 
-// このライブラリが使う名前空間
+/**
+ * @brief ssrライブラリが使う名前空間
+ */
 namespace ssr {
-
-// デジタル入力ピンを扱う
-class DigitalIn : Input<bool> {
-public:
-    // 接続ピン
-    const PinType pin;
-
     /**
-     * 初期化子
-     * @param PinType pin 接続ピン
+     * @brief デジタル入力ピンを扱う
      */
-    DigitalIn(PinType pin);
-    // ピンの初期設定。全体のsetup()内でこれを呼び出すこと
-    void begin();
-    /**
-     * 接続したピンの値を読む
-     * @return bool HIGHならtrue
-     */
-    bool read() override;
-};
+    class DigitalIn : Input<bool> {
+    public:
+        /**
+         * @brief 接続ピン
+         */
+        const PinType pin;
+
+        /**
+         * @brief 初期化子
+         * @param pin ssr::PinType 接続ピン
+         */
+        DigitalIn(PinType pin);
+
+        /**
+         * @brief ピンの初期設定。全体のsetup()内でこれを呼び出すこと
+         */
+        void begin();
 
-}
+        /**
+         * @brief 接続したピンの値を読む
+         * @return bool HIGHならtrue
+         */
+        bool read() override;
+    }; // class DigitalIn
+} // namespace ssr
 
 #endif /* SSR_DIGITAL_IN_HPP */

include/ssr/DigitalOut.hpp

@@ -1,59 +1,79 @@
+/**
+ * @file DigitalOut.hpp
+ * @author H1rono (hronok66@gmail.com)
+ * @brief デジタル出力ピン型Digitalout
+ * @version 0.1
+ * @copyright Copyright (c) 2022 ssr2022-saka-maza
+ */
+
 #pragma once
 
 #ifndef SSR_DIGITAL_OUT_HPP
+
+/**
+ * @brief ssr/DigitalOut.hppがインクルードされていることを示すdefine
+ */
 #define SSR_DIGITAL_OUT_HPP
 
 #include <Arduino.h>
 #include "ssr/PinType.hpp"
 #include "ssr/Output.hpp"
 
-// このライブラリが使う名前空間
+/**
+ * @brief ssrライブラリが使う名前空間
+ */
 namespace ssr {
-
-// デジタル出力ピンを扱う
-class DigitalOut : Output<bool> {
-private:
-    // 設定した値
-    bool _value;
-public:
-    // 接続ピン
-    const PinType pin;
-
     /**
-     * 初期化子
-     * @param PinType pin 接続ピン
-     * @param bool value 初期値 デフォルトはfalse(LOW)
+     * @brief デジタル出力ピンを扱う型
      */
-    DigitalOut(PinType pin);
+    class DigitalOut : Output<bool> {
+    private:
+        /**
+         * @brief 最後に出力した値
+         */
+        bool _value;
+    public:
+        /**
+         * @brief 接続ピン
+         */
+        const PinType pin;
 
-    /**
-     * ピンの初期設定。全体のsetup()でこれを呼び出すこと
-     * @param bool value 初期値 デフォルトはfalse(LOW)
-     */
-    void begin(bool value = false);
+        /**
+         * 初期化子
+         * @param pin ssr::PinType 接続ピン
+         * @param value bool 初期値 デフォルトはfalse(LOW)
+         */
+        DigitalOut(PinType pin);
 
-    /**
-     * 最後に設定した値を返す
-     * @return bool 最後に設定した値 HIGHはtrue
-     */
-    bool getValue();
+        /**
+         * @brief ピンの初期設定。全体のsetup()でこれを呼び出すこと
+         * @param value bool 初期値 デフォルトはfalse(LOW)
+         */
+        void begin(bool value = false);
 
-    /**
-     * 値を設定する
-     * @param bool value 設定する値。trueでHIGH, falseでLOW
-     */
-    void setValue(bool value);
+        /**
+         * @brief 最後に設定した値を返す
+         * @return bool 最後に設定した値 HIGHはtrue
+         */
+        bool getValue();
 
-    /**
-     * 値を出力する
-     * @param bool value 出力する値
-     */
-    void write(bool value) override;
+        /**
+         * @brief 値を設定する
+         * @param value bool 出力する値。trueでHIGH, falseでLOW
+         */
+        void setValue(bool value);
 
-    // 最後に設定した値と逆の値を書き込む
-    void toggle();
-};
+        /**
+         * @brief 値を出力する
+         * @param value bool 出力する値
+         */
+        void write(bool value) override;
 
-}
+        /**
+         * @brief 出力を反転させる
+         */
+        void toggle();
+    }; // class DigitalOut
+} // namespace ssr
 
 #endif /* SSR_DIGITAL_OUT_HPP */