[PATCH 08/22] gweb: Add documentation to 'call_result_func'.
Grant Erickson <[email protected]>
| Newsgroups | dev.linux.lists.connman |
|---|---|
| Message-ID | <5bca4dd1ae8cf27646239ffd4a1f3640cf455075.1741050622.git.gerickson@nuovations.com> |
Add documentation to the 'call_result_func' function.
---
gweb/gweb.c | 28 ++++++++++++++++++++++++++++
1 file changed, 28 insertions(+)
diff --git a/gweb/gweb.c b/gweb/gweb.c
index f5accf80cbeb..0256d622e00a 100644
--- a/gweb/gweb.c
+++ b/gweb/gweb.c
@@ -164,6 +164,34 @@ static void _debug(GWeb *web, const char *file, const char *caller,
va_end(ap);
}
+/**
+ * @brief
+ * Invoke the closure callback associated with the web session
+ * request.
+ *
+ * This closes the specified web session request by invoking the @a
+ * result_func originally assigned in #do_request when the session
+ * was first initiated.
+ *
+ * @param[in] session
+ * A pointer to the mutable web session request for which to invoke
+ * the closure callback.
+ *
+ * @param[in] err
+ * Operating system error to set in the @a session result
+ * structure.
+ *
+ * @param[in] status
+ * HTTP status code on success to set in the @a session result
+ * structure. Note that #GWEB_HTTP_STATUS_CODE_UNKNOWN acts as a
+ * null value such that the status is only set if the value is
+ * not #GWEB_HTTP_STATUS_CODE_UNKNOWN.
+ *
+ * @sa do_request
+ *
+ * @private
+ *
+ */
static inline void call_result_func(struct web_session *session,
int err, guint16 status)
{
--
2.45.0