[08/17] wispr: Add documentation to 'cancel_connman_wispr_portal_context'.

Commit Message

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

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

Patch

diff --git a/src/wispr.c b/src/wispr.c
index 84d4b1d0efb4..1e62e0cd2dee 100644
--- a/src/wispr.c
+++ b/src/wispr.c
@@ -166,6 +166,24 @@  static void free_wispr_routes(struct connman_wispr_portal_context *wp_context)
 	}
 }
 
+/**
+ *  @brief
+ *    Cancel a WISPr/portal request.
+ *
+ *  This attempts to cancel any outstanding request associated with
+ *  the specified WISPr/portal context. This deallocates any resources
+ *  associated with the context, except for the context itself which
+ *  requires invoking #free_connman_wispr_portal_context.
+ *
+ *  @param[in,out]  wp_context  A pointer to the mutable WISPr/portal
+ *                              context for which to cancel an outstanding
+ *                              request, whether a reachability check
+ *                              or otherwise.
+ *
+ *  @sa create_connman_wispr_portal_context
+ *  @sa free_connman_wispr_portal_context
+ *
+ */
 static void cancel_connman_wispr_portal_context(
 		struct connman_wispr_portal_context *wp_context)
 {