Merge pull request #416 from sinricpro/fix-rangeValue-documentation

Update RangeController.h documentation
sinricpro · Jan 29, 2025 · 6067b2d · 6067b2d
2 parents 95edd14 + 649ceeb
commit 6067b2d
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/src/Capabilities/RangeController.h b/src/Capabilities/RangeController.h
@@ -194,7 +194,7 @@ void RangeController<T>::onAdjustRangeValue(const String &instance, GenericAdjus
 /**
  * @brief Send `rangeValue` event to report curent rangeValue to SinricPro server
  * 
- * @param   rangeValue  Value between 0..3
+ * @param   rangeValue  value for the range.
  * @param   cause       (optional) `String` reason why event is sent (default = `"PHYSICAL_INTERACTION"`)
  * @return  the success of sending the even
  * @retval  true        event has been sent successfully
@@ -215,7 +215,7 @@ bool RangeController<T>::sendRangeValueEvent(int rangeValue, String cause) {
  * @brief Send `rangeValue` event to report curent rangeValue to SinricPro server for a specific instance (custom device)
  * 
  * @param   instance    String instance name
- * @param   rangeValue  Value between 0..3
+ * @param   rangeValue  value for the range
  * @param   cause       (optional) `String` reason why event is sent (default = `"PHYSICAL_INTERACTION"`)
  * @return  the success of sending the even
  * @retval  true        event has been sent successfully
@@ -323,4 +323,4 @@ bool RangeController<T>::handleRangeController(SinricProRequest &request) {
 } // SINRICPRO_NAMESPACE
 
 template <typename T>
-using RangeController = SINRICPRO_NAMESPACE::RangeController<T>;
+using RangeController = SINRICPRO_NAMESPACE::RangeController<T>;