[v2,28/60] service: Document 'online_check_failures_threshold_was_met'.

Commit Message

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

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

Patch

diff --git a/src/service.c b/src/service.c
index 15a79c0aa5c8..e8fc14f1c4ca 100644
--- a/src/service.c
+++ b/src/service.c
@@ -2168,6 +2168,23 @@  done:
 	return status;
 }
 
+/**
+ *  @brief
+ *    Return the online check failures threshold state.
+ *
+ *  @param[in]  service  A pointer to the immutable service for which
+ *                       to return the online check failures threshold
+ *                       state.
+ *
+ *  @returns
+ *    True if the online check failures threshold was met; otherwise,
+ *    false.
+ *
+ *  @sa online_check_failures_threshold_was_met_set_value
+ *  @sa online_check_failures_threshold_was_met_set
+ *  @sa online_check_failures_threshold_was_met_clear
+ *
+ */
 static bool online_check_failures_threshold_was_met(
 			const struct connman_service *service)
 {