[03/17] wispr: Add documentation to 'is_wispr_supported'.

Commit Message

Grant Erickson Nov. 16, 2023, 1:02 a.m. UTC

This adds documentation to the 'is_wispr_supported' function.
---
 src/wispr.c | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

Patch

diff --git a/src/wispr.c b/src/wispr.c
index 9c99402c8c6d..215c6217a02b 100644
--- a/src/wispr.c
+++ b/src/wispr.c
@@ -1072,6 +1072,25 @@  done:
 	return err;
 }
 
+/**
+ *  @brief
+ *    Return whether WISPr requests / HTTP-based Internet reachability
+ *    checks are supported.
+ *
+ *  This determines whether WISPr requests / HTTP-based Internet
+ *  reachability check are supported for the specified network service
+ *  based on its associated technology type.
+ *
+ *  @param[in]  service  A pointer to the immutable network service
+ *                       for which to check WISPr requests / HTTP-based
+ *                       Internet reachability check support.
+ *
+ *  @returns
+ *    True if the network service technology type supports WISPr
+ *    requests / HTTP-based Internet reachability checks; otherwise,
+ *    false.
+ *
+ */
 static bool is_wispr_supported(const struct connman_service *service)
 {
 	if (!service)