[v2,32/60] service: Document 'online_check_{failures,successes}_reset'.

Commit Message

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

This adds documentation to the
'online_check_{failures,successes}_reset' functions.
---
 src/service.c | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

Patch

diff --git a/src/service.c b/src/service.c
index 8a1d09f1a4fd..810ff68cf4f4 100644
--- a/src/service.c
+++ b/src/service.c
@@ -2266,6 +2266,18 @@  static inline void online_check_counter_reset(
 	*counter = 0;
 }
 
+/**
+ *  @brief
+ *    Reset to zero (0) the IPv4 and IPv6 online check failure
+ *    counters for the specified service.
+ *
+ *  @param[in]   service   A pointer to the mutable service for which
+ *                         to reset the IPv4 and IPv6 online check
+ *                         failure counters.
+ *
+ *  @sa online_check_successes_reset
+ *
+ */
 static void online_check_failures_reset(struct connman_service *service)
 {
 	DBG("service %p (%s)",
@@ -2275,6 +2287,18 @@  static void online_check_failures_reset(struct connman_service *service)
 	online_check_counter_reset(&service->online_check_state_ipv6.failures);
 }
 
+/**
+ *  @brief
+ *    Reset to zero (0) the IPv4 and IPv6 online check success
+ *    counters for the specified service.
+ *
+ *  @param[in]   service   A pointer to the mutable service for which
+ *                         to reset the IPv4 and IPv6 online check
+ *                         success counters.
+ *
+ *  @sa online_check_failures_reset
+ *
+ */
 static void online_check_successes_reset(struct connman_service *service)
 {
 	DBG("service %p (%s)",