minor changesin comments reverted

Author: mathertel

src/OneButton.cpp

@@ -62,44 +62,44 @@ OneButton::OneButton(const int pin, const boolean activeLow, const bool pullupAc
 void OneButton::setDebounceTicks(const unsigned int ms)
 {
   _debounce_ms = ms;
-}
+} // setDebounceTicks
 
 
 // explicitly set the number of millisec that have to pass by before a click is detected.
 void OneButton::setClickTicks(const unsigned int ms)
 {
   _click_ms = ms;
-}
+} // setClickTicks
 
 
 // explicitly set the number of millisec that have to pass by before a long button press is detected.
 void OneButton::setPressTicks(const unsigned int ms)
 {
   _press_ms = ms;
-}
+} // setPressTicks
 
 
 // save function for click event
 void OneButton::attachClick(callbackFunction newFunction)
 {
   _clickFunc = newFunction;
-}
+} // attachClick
 
 
 // save function for parameterized click event
 void OneButton::attachClick(parameterizedCallbackFunction newFunction, void *parameter)
 {
   _paramClickFunc = newFunction;
   _clickFuncParam = parameter;
-}
+} // attachClick
 
 
 // save function for doubleClick event
 void OneButton::attachDoubleClick(callbackFunction newFunction)
 {
   _doubleClickFunc = newFunction;
   _maxClicks = max(_maxClicks, 2);
-}
+} // attachDoubleClick
 
 
 // save function for parameterized doubleClick event
@@ -108,15 +108,15 @@ void OneButton::attachDoubleClick(parameterizedCallbackFunction newFunction, voi
   _paramDoubleClickFunc = newFunction;
   _doubleClickFuncParam = parameter;
   _maxClicks = max(_maxClicks, 2);
-}
+} // attachDoubleClick
 
 
 // save function for multiClick event
 void OneButton::attachMultiClick(callbackFunction newFunction)
 {
   _multiClickFunc = newFunction;
   _maxClicks = max(_maxClicks, 100);
-}
+} // attachMultiClick
 
 
 // save function for parameterized MultiClick event
@@ -125,52 +125,52 @@ void OneButton::attachMultiClick(parameterizedCallbackFunction newFunction, void
   _paramMultiClickFunc = newFunction;
   _multiClickFuncParam = parameter;
   _maxClicks = max(_maxClicks, 100);
-}
+} // attachMultiClick
 
 
 // save function for longPressStart event
 void OneButton::attachLongPressStart(callbackFunction newFunction)
 {
   _longPressStartFunc = newFunction;
-}
+} // attachLongPressStart
 
 
 // save function for parameterized longPressStart event
 void OneButton::attachLongPressStart(parameterizedCallbackFunction newFunction, void *parameter)
 {
   _paramLongPressStartFunc = newFunction;
   _longPressStartFuncParam = parameter;
-}
+} // attachLongPressStart
 
 
 // save function for longPressStop event
 void OneButton::attachLongPressStop(callbackFunction newFunction)
 {
   _longPressStopFunc = newFunction;
-}
+} // attachLongPressStop
 
 
 // save function for parameterized longPressStop event
 void OneButton::attachLongPressStop(parameterizedCallbackFunction newFunction, void *parameter)
 {
   _paramLongPressStopFunc = newFunction;
   _longPressStopFuncParam = parameter;
-}
+} // attachLongPressStop
 
 
 // save function for during longPress event
 void OneButton::attachDuringLongPress(callbackFunction newFunction)
 {
   _duringLongPressFunc = newFunction;
-}
+} // attachDuringLongPress
 
 
 // save function for parameterized during longPress event
 void OneButton::attachDuringLongPress(parameterizedCallbackFunction newFunction, void *parameter)
 {
   _paramDuringLongPressFunc = newFunction;
   _duringLongPressFuncParam = parameter;
-}
+} // attachDuringLongPress
 
 
 void OneButton::reset(void)
@@ -189,8 +189,9 @@ int OneButton::getNumberClicks(void)
 
 
 /**
- * @brief Check input of the configured pin, debounce input pin level and then advance the finite state
- * machine (FSM).
+ * @brief Check input of the configured pin,
+ * debounce input pin level and then
+ * advance the finite state machine (FSM).
  */
 void OneButton::tick(void)
 {
@@ -206,7 +207,7 @@ void OneButton::tick(void)
       _lastDebounceTime = now;
     }
   }
-}
+} // tick()
 
 
 /**
@@ -215,7 +216,7 @@ void OneButton::tick(void)
 void OneButton::_newState(stateMachine_t nextState)
 {
   _state = nextState;
-}
+} // _newState()
 
 
 /**
@@ -233,7 +234,7 @@ void OneButton::tick(bool activeLevel)
       _newState(OneButton::OCS_DOWN);
       _startTime = now; // remember starting time
       _nClicks = 0;
-    }
+    } // if
     break;
 
   case OneButton::OCS_DOWN:
@@ -247,7 +248,7 @@ void OneButton::tick(bool activeLevel)
       if (_longPressStartFunc) _longPressStartFunc();
       if (_paramLongPressStartFunc) _paramLongPressStartFunc(_longPressStartFuncParam);
       _newState(OneButton::OCS_PRESS);
-    }
+    } // if
     break;
 
   case OneButton::OCS_UP:
@@ -283,10 +284,10 @@ void OneButton::tick(bool activeLevel)
         // this was a multi click sequence.
         if (_multiClickFunc) _multiClickFunc();
         if (_paramMultiClickFunc) _paramMultiClickFunc(_multiClickFuncParam);
-      }
+      } // if
 
       reset();
-    }
+    } // if
     break;
 
   case OneButton::OCS_PRESS:
@@ -300,7 +301,7 @@ void OneButton::tick(bool activeLevel)
       // still the button is pressed
       if (_duringLongPressFunc) _duringLongPressFunc();
       if (_paramDuringLongPressFunc) _paramDuringLongPressFunc(_duringLongPressFuncParam);
-    }
+    } // if
     break;
 
   case OneButton::OCS_PRESSEND:
@@ -315,6 +316,9 @@ void OneButton::tick(bool activeLevel)
     // unknown state detected -> reset state machine
     _newState(OneButton::OCS_INIT);
     break;
-  }
+  } // if
 
 } // OneButton.tick()
+
+
+// end.

src/OneButton.h

@@ -202,7 +202,7 @@ class OneButton
     OCS_DOWN = 1, // button is down
     OCS_UP = 2, // button is up
     OCS_COUNT = 3,
-    OCS_PRESS = 6, // button is holded down
+    OCS_PRESS = 6, // button is hold down
     OCS_PRESSEND = 7,
   };