[v2,06/17] wispr: Add documentation to '__connman_wispr_stop'.

Commit Message

Grant Erickson Nov. 19, 2023, 5:07 p.m. UTC

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

Patch

diff --git a/src/wispr.c b/src/wispr.c
index 84ad21c2d6fb..41f5d462da41 100644
--- a/src/wispr.c
+++ b/src/wispr.c
@@ -1268,6 +1268,22 @@  free_wp:
 	return err;
 }
 
+/**
+ *  @brief
+ *    Stop all HTTP-based Internet reachability checks for the specified
+ *    network service.
+ *
+ *  This attempts to stop all HTTP-based Internet reachability checks
+ *  for the specified network service.
+ *
+ *  @param[in,out]  service  A pointer to the mutable network service
+ *                           for which to stop all reachability
+ *                           checks.
+ *
+ *  @sa __connman_wispr_start
+ *  @sa __connman_wispr_cancel
+ *
+ */
 void __connman_wispr_stop(struct connman_service *service)
 {
 	struct connman_wispr_portal *wispr_portal;