[05/15] service: Document 'service_log_pac'.

Commit Message

Grant Erickson Dec. 12, 2024, 5:28 a.m. UTC

Add documentation to the 'service_log_pac' function.
---
 src/service.c | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

Patch

diff --git a/src/service.c b/src/service.c
index 73cf8bca71a2..a4b13be2fd47 100644
--- a/src/service.c
+++ b/src/service.c
@@ -556,6 +556,21 @@  int __connman_service_load_modifiable(struct connman_service *service)
 	return 0;
 }
 
+/**
+ *  @brief
+ *    Log the proxy auto-configuration (PAC) URL associated with the
+ *    specified service.
+ *
+ *  @param[in]  service  A pointer to the immutable network
+ *                       service for which to log the proxy
+ *                       auto-configuration (PAC) URL.
+ *  @param[in]  url      An optional pointer to the immutable null-
+ *                       terminated C string containing the proxy
+ *                       auto-configuration (PAC) URL.
+ *
+ *  @private
+ *
+ */
 static void service_log_pac(const struct connman_service *service,
 				const char *url)
 {