[v2,38/60] service: Document 'is_online_check_success_threshold_met_predicate'.

Commit Message

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

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

Patch

diff --git a/src/service.c b/src/service.c
index beb339b89256..6a9db3c98e56 100644
--- a/src/service.c
+++ b/src/service.c
@@ -2546,6 +2546,32 @@  static bool online_check_failures_threshold_is_met(
 			is_online_check_failure_threshold_met_predicate);
 }
 
+/**
+ *  @brief
+ *    Determine whether the service has met the online check success
+ *    threshold.
+ *
+ *  This predicate determines whether the online check success
+ *  threshold has been met by the specified network service.
+ *
+ *  @param[in]  service                A pointer to the immutable
+ *                                     network service for which to
+ *                                     check whether its has met the
+ *                                     online check success threshold.
+ *  @param[in]  counter_description    A pointer to a null-terminated
+ *                                     C string describing the success
+ *                                     counter. For example,
+ *                                     "success".
+ *  @param[in]  counter_threshold      The threshold value to check the
+ *                                     success counter against.
+ *
+ *  @returns
+ *    True if the online check success counter has met the success
+ *    threshold; otherwise, false.
+ *
+ *  @sa online_check_successes_threshold_is_met
+ *
+ */
 static bool is_online_check_success_threshold_met_predicate(
 			const struct connman_service *service,
 			const char *counter_description,