[v2,37/60] service: Document 'online_check_failures_threshold_is_met'.

Commit Message

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

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

Patch

diff --git a/src/service.c b/src/service.c
index 8c8ff1c7a496..beb339b89256 100644
--- a/src/service.c
+++ b/src/service.c
@@ -2512,6 +2512,26 @@  static bool is_online_check_failure_threshold_met_predicate(
 	return threshold_met;
 }
 
+/**
+ *  @brief
+ *    Determine whether the online check failures threshold is met.
+ *
+ *  This attempts to determine whether the online check failures
+ *  threshold is met, comparing the current IPv4 and IPv6 online check
+ *  failure counts against the "OnlineCheckFailuresThreshold" settings
+ *  value and returning @a true if @b both the IPv4 and IPv6 counts
+ *  meet or exceed the threshold.
+ *
+ *  @param[in]  service  A pointer to the immutable service for which
+ *                       to determine whether the online check failure
+ *                       threshold is met.
+ *
+ *  @returns
+ *    True if the failure threshold is met; otherwise, false.
+ *
+ *  @sa online_check_successes_threshold_is_met
+ *
+ */
 static bool online_check_failures_threshold_is_met(
 			const struct connman_service *service)
 {