Add param to docstring

adafruit · Oct 18, 2024 · c6bcc5c · c6bcc5c
1 parent 399dd77
commit c6bcc5c
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 5 deletions.
diff --git a/src/components/analogIO/Wippersnapper_AnalogIO.cpp b/src/components/analogIO/Wippersnapper_AnalogIO.cpp
@@ -316,14 +316,16 @@ bool Wippersnapper_AnalogIO::encodePinEvent(
     @brief    Calculates the hysteresis for the pin value.
     @param    pin
               The desired analog pin to calculate hysteresis for.
-    @param    _pinValThreshHi
+    @param    pinValRaw
+              The pin's raw value.
+    @param    pinValThreshHi
               The pin's high threshold value.
-    @param    _pinValThreshLow
+    @param    pinValThreshLow
               The pin's low threshold value.
 */
 /**********************************************************/
 void calculateHysteresis(analogInputPin pin, uint16_t pinValRaw,
-                         uint16_t _pinValThreshHi, uint16_t _pinValThreshLow) {
+                         uint16_t pinValThreshHi, uint16_t pinValThreshLow) {
   // All boards ADC values scaled to 16bit, in future we may need to
   // adjust dynamically
   uint16_t maxDecimalValue = 65535;
@@ -342,8 +344,8 @@ void calculateHysteresis(analogInputPin pin, uint16_t pinValRaw,
   }
 
   // get the threshold values for previous pin value
-  _pinValThreshHi = pin.prvPinVal + CURRENT_HYSTERISIS;
-  _pinValThreshLow = pin.prvPinVal - CURRENT_HYSTERISIS;
+  pinValThreshHi = pin.prvPinVal + CURRENT_HYSTERISIS;
+  pinValThreshLow = pin.prvPinVal - CURRENT_HYSTERISIS;
 }
 
 /**********************************************************/

diff --git a/src/components/analogIO/Wippersnapper_AnalogIO.h b/src/components/analogIO/Wippersnapper_AnalogIO.h
@@ -57,6 +57,8 @@ class Wippersnapper_AnalogIO {
                   int pin);
   void disableAnalogInPin(int pin);
 
+  void calculateHysteresis(analogInputPin pin, uint16_t pinValRaw,
+                           uint16_t &_pinValThreshHi, uint16_t &_pinValThreshLow);
   uint16_t getPinValue(int pin);
   float getPinValueVolts(int pin);