[v2,33/60] service: Document 'online_check_state_reset'.

Commit Message

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

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

Patch

diff --git a/src/service.c b/src/service.c
index 810ff68cf4f4..5dfada3af3f5 100644
--- a/src/service.c
+++ b/src/service.c
@@ -2308,6 +2308,22 @@  static void online_check_successes_reset(struct connman_service *service)
 	online_check_counter_reset(&service->online_check_state_ipv6.successes);
 }
 
+/**
+ *  @brief
+ *    Reset the online check state for the specified service.
+ *
+ *  This resets the online check state for the specified service,
+ *  including its failure threshold state, failure counters, and
+ *  success counters.
+ *
+ *  @param[in]   service   A pointer to the mutable service for which
+ *                         to reset the online check state.
+ *
+ *  @sa online_check_failures_reset
+ *  @sa online_check_successes_reset
+ *  @sa online_check_failures_threshold_was_met_clear
+ *
+ */
 static void online_check_state_reset(struct connman_service *service)
 {
 	online_check_failures_reset(service);