[15/15] wispr: Document 'wispr_log_proxy_failure'.

Commit Message

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

Add documentation to the 'wispr_log_proxy_failure' function.
---
 src/wispr.c | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

Patch

diff --git a/src/wispr.c b/src/wispr.c
index 10990c725986..9b0e4b24a3db 100644
--- a/src/wispr.c
+++ b/src/wispr.c
@@ -1118,6 +1118,26 @@  static char *parse_proxy(const char *proxy)
 	return proxy_server;
 }
 
+/**
+ *  @brief
+ *    Log a Wireless Internet Service Provider roaming (WISPr) proxy
+ *    auto-configuration (PAC)-related online reachability check
+ *    failure.
+ *
+ *  @param[in]  wp_context  A pointer to the immutable WISPr/portal
+ *                          context for which to log the proxy
+ *                          auto-configuration (PAC)-related online
+ *                          reachability check failure.
+ *  @param[in]  reason      A pointer to an immutable, null-terminated
+ *                          C string containing the reason for the
+ *                          proxy auto-configuration (PAC)-related
+ *                          online reachability check failure which
+ *                          will be included at the start of the log
+ *                          message.
+ *
+ *  @private
+ *
+ */
 static void wispr_log_proxy_failure(
 		struct connman_wispr_portal_context const *wp_context,
 		const char *reason)