[v3,41/60] service: Document 'online_check_log_success'.

Commit Message

Grant Erickson Dec. 21, 2023, 10:34 p.m. UTC

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

Patch

diff --git a/src/service.c b/src/service.c
index 9d27a5692034..029d7b8b6122 100644
--- a/src/service.c
+++ b/src/service.c
@@ -2871,6 +2871,20 @@  static void online_check_counter_increment_and_log(
 		counter_description, *counter);
 }
 
+/**
+ *  @brief
+ *    Log an online check success.
+ *
+ *  This logs an online check success for the specified network
+ *  service IP configuration type.
+ *
+ *  @param[in]  service  A pointer to the immutable network
+ *                       service for which to log an online
+ *                       check success.
+ *  @param[in]  type     The IP configuration type for which
+ *                       the online check was successful.
+ *
+ */
 static void online_check_log_success(const struct connman_service *service,
 			enum connman_ipconfig_type type)
 {