[v2,49/60] service: Document 'downgrade_connected_services'.

Commit Message

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

This adds documentation to the 'downgrade_connected_services'
functions.
---
 src/service.c | 13 +++++++++++++
 1 file changed, 13 insertions(+)

Patch

diff --git a/src/service.c b/src/service.c
index cae4258fca7f..efed2fc50ac9 100644
--- a/src/service.c
+++ b/src/service.c
@@ -8709,6 +8709,19 @@  static void request_input_cb(struct connman_service *service,
 	}
 }
 
+/**
+ *  @brief
+ *    Downgrade the service IPv4 and IPv6 states from "online" to
+ *    "ready" of all connected services.
+ *
+ *  This attempts to downgrade the IPv4 and IPv6 states of all
+ *  @a is_connected services to "ready" if they are "online".
+ *
+ *  @sa service_ipconfig_downgrade_online_state
+ *  @sa service_downgrade_online_state
+ *  @sa service_downgrade_online_state_if_default
+ *
+ */
 static void downgrade_connected_services(void)
 {
 	struct connman_service *up_service;