[v2,44/60] service: Document 'online_check_log_failure'.

Commit Message

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

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

Patch

diff --git a/src/service.c b/src/service.c
index 62edabed1b1b..b2eb00a3e774 100644
--- a/src/service.c
+++ b/src/service.c
@@ -3248,6 +3248,22 @@  static bool handle_online_check_success(struct connman_service *service,
 	return reschedule;
 }
 
+/**
+ *  @brief
+ *    Log an online check failure.
+ *
+ *  This logs an online check failure 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 failure.
+ *  @param[in]  type     The IP configuration type for which
+ *                       the online check failed.
+ *  @param[in]  err      The error status, in the POSIX domain,
+ *                       associated with the online check failure.
+ *
+ */
 static void online_check_log_failure(const struct connman_service *service,
 			enum connman_ipconfig_type type,
 			int err)