Added comments

2025-11-01 19:20:01 +01:00
parent 1837e09bc1
commit 0cc6f49130
4 changed files with 42 additions and 1 deletions
--- a/include/commonFunctions.h
+++ b/include/commonFunctions.h
@@ -11,6 +11,21 @@ private:
    int lastPin;

 public:
+    /**
+     * @brief Function used to read state of a normally open(LOW) button
+     *
+     * @param buttonPin The pin of the button
+     * @return true
+     * @return false
+     */
    bool debounceReadNO(int buttonPin);
+
+    /**
+     * @brief Function used to read state of a normally closed(HIGH) button
+     *
+     * @param buttonPin The pin of the button
+     * @return true
+     * @return false
+     */
    bool debounceReadNC(int buttonPin);
 };