[v2,30/60] service: Document 'online_check_failures_threshold_was_met_{set,clear}'.

Commit Message

Grant Erickson Dec. 21, 2023, 6:39 a.m. UTC

This adds documentation to the
'online_check_failures_threshold_was_met_{set,clear}' functions.
---
 src/service.c | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

Patch

diff --git a/src/service.c b/src/service.c
index b41f29d73d60..6e34b4c8ef34 100644
--- a/src/service.c
+++ b/src/service.c
@@ -2215,12 +2215,35 @@  static void online_check_failures_threshold_was_met_set_value(
 	service->online_check_failures_met_threshold = value;
 }
 
+/**
+ *  @brief
+ *    Set (that is, assert) the online check failures threshold state.
+ *
+ *  @param[in,out]  service  A pointer to the mutable service for which
+ *                           to set the failures threshold state.
+ *
+ *  @sa online_check_failures_threshold_was_met_set_value
+ *  @sa online_check_failures_threshold_was_met_clear
+ *
+ */
 static void online_check_failures_threshold_was_met_set(
 			struct connman_service *service)
 {
 	online_check_failures_threshold_was_met_set_value(service, true);
 }
 
+/**
+ *  @brief
+ *    Clear (that is, deassert) the online check failures threshold
+ *    state.
+ *
+ *  @param[in,out]  service  A pointer to the mutable service for which
+ *                           to clear the failures threshold state.
+ *
+ *  @sa online_check_failures_threshold_was_met_set_value
+ *  @sa online_check_failures_threshold_was_met_set
+ *
+ */
 static void online_check_failures_threshold_was_met_clear(
 			struct connman_service *service)
 {