[v2,24/60] service: Document 'connman_service' 'online_check_state_ipv{4,6}' members.

Commit Message

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

This documents the 'online_check_state_ipv{4,6}' members of the
'connman_service' structure.
---
 src/service.c | 8 ++++++++
 1 file changed, 8 insertions(+)

Patch

diff --git a/src/service.c b/src/service.c
index 2ce829ae37a7..6c898476627b 100644
--- a/src/service.c
+++ b/src/service.c
@@ -186,7 +186,15 @@  struct connman_service {
 	char *pac;
 	bool wps;
 	bool wps_advertizing;
+
+    /**
+     *  IPv4-specific "online" reachability check state.
+     */
 	struct online_check_state online_check_state_ipv4;
+
+    /**
+     *  IPv6-specific "online" reachability check state.
+     */
 	struct online_check_state online_check_state_ipv6;
 
     /**