[PATCH v2 19/22] wispr: Document 'wispr_portal_web_result_no_err'.
Grant Erickson <[email protected]>
| Newsgroups | dev.linux.lists.connman |
|---|---|
| Message-ID | <27f48e9dd2863ab5b1ee98d38121f594151d4641.1741059516.git.gerickson@nuovations.com> |
Add documentation to the 'wispr_portal_web_result_no_err' function.
---
src/wispr.c | 19 +++++++++++++++++++
1 file changed, 19 insertions(+)
diff --git a/src/wispr.c b/src/wispr.c
index b3fc99949206..bab12400aae7 100644
--- a/src/wispr.c
+++ b/src/wispr.c
@@ -1036,6 +1036,25 @@ static void wispr_portal_web_result_err(GWebResult *result,
wp_context->request_id = 0;
}
+/**
+ * @brief
+ * Handle closure and finalization of a web request associated with
+ * a successful "online" HTTP-based Internet reachability check.
+ *
+ * @param[in] result A pointer to the mutable web request
+ * result being finalized.
+ * @param[in,out] wp_context A pointer to the mutable WISPr portal
+ * detection context associated with the
+ * successful "online" HTTP-based
+ * Internet reachability check this is
+ * finalizing.
+ *
+ * @sa wispr_portal_web_result
+ * @sa wispr_portal_web_result_no_err
+ *
+ * @private
+ *
+ */
static void wispr_portal_web_result_no_err(GWebResult *result,
struct connman_wispr_portal_context *wp_context)
{
--
2.45.0