[v2,23/60] service: Document 'connman_service' 'online_check_failures_met_threshold' member.

Commit Message

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

This documents the 'online_check_failures_met_threshold' member of the
'connman_service' structure.
---
 src/service.c | 6 ++++++
 1 file changed, 6 insertions(+)

Patch

diff --git a/src/service.c b/src/service.c
index d75399062ed7..2ce829ae37a7 100644
--- a/src/service.c
+++ b/src/service.c
@@ -188,6 +188,12 @@  struct connman_service {
 	bool wps_advertizing;
 	struct online_check_state online_check_state_ipv4;
 	struct online_check_state online_check_state_ipv6;
+
+    /**
+     *  Tracks whether the service has met the number of sustained,
+     *  back-to-back "online" reachability check failures for
+     *  "continuous" online check mode.
+     */
 	bool online_check_failures_met_threshold;
 	bool do_split_routing;
 	bool new_service;