docs: added function return (#159)

UCSD-E4E · Jan 6, 2025 · e104ce3 · e104ce3
2 parents 35f29c0 + 0f770a9
commit e104ce3
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/src/watersensor/waterSensor.cpp b/src/watersensor/waterSensor.cpp
@@ -170,9 +170,9 @@ void WaterSensor::forceState(uint8_t water_detect_state)
 
 /**
  * @brief gets the current reading of the sensor (not the overall status w/ hystersis)
- * 
- * @return uint8_t 
- */ 
+ *
+ * @return uint8_t current reading of the sensor
+ */
 uint8_t WaterSensor::getCurrentReading()
 {
     uint8_t temp_8;