[v2,29/60] service: Document 'online_check_failures_threshold_was_met_set_value'.

Commit Message

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

This adds documentation to the
'online_check_failures_threshold_was_met_set_value' function.
---
 src/service.c | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

Patch

diff --git a/src/service.c b/src/service.c
index e8fc14f1c4ca..b41f29d73d60 100644
--- a/src/service.c
+++ b/src/service.c
@@ -2191,6 +2191,20 @@  static bool online_check_failures_threshold_was_met(
 	return service->online_check_failures_met_threshold;
 }
 
+/**
+ *  @brief
+ *    Set the online check failures threshold state to the specified
+ *    value.
+ *
+ *  @param[in,out]  service  A pointer to the mutable service for which
+ *                           to set the failures threshold state.
+ *  @param[in]      value    The value to set the @a service failures
+ *                           threshold state to.
+ *
+ *  @sa online_check_failures_threshold_was_met_set
+ *  @sa online_check_failures_threshold_was_met_clear
+ *
+ */
 static void online_check_failures_threshold_was_met_set_value(
 			struct connman_service *service, bool value)
 {