[v2,40/60] service: Document 'online_check_counter_increment_and_log'.

Commit Message

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

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

Patch

diff --git a/src/service.c b/src/service.c
index 333c072739ed..9d27a5692034 100644
--- a/src/service.c
+++ b/src/service.c
@@ -2836,6 +2836,24 @@  static void reschedule_online_check(struct connman_service *service,
 		online_check_state->interval++;
 }
 
+/**
+ *  @brief
+ *    Increment and log the specified online check counter.
+ *
+ *  This increments by one (1) and logs the post-increment value of
+ *  the specified online check counter associated with the specified
+ *  network service.
+ *
+ *  @param[in]  service              A pointer to the immutable network
+ *                                   service associated with @a
+ *                                   counter.
+ *  @param[in]  type                 The IP configuration type associated
+ *                                   with @a counter.
+ *  @param[in]  counter_description  A pointer to a null-terminated C
+ *                                   string describing @a counter. For
+ *                                   example, "failure".
+ *
+ */
 static void online_check_counter_increment_and_log(
 			const struct connman_service *service,
 			enum connman_ipconfig_type type,