[PATCH v2 10/22] gweb: Add documentation to 'received_data'.
Grant Erickson <[email protected]>
| Newsgroups | dev.linux.lists.connman |
|---|---|
| Message-ID | <0c04ea4d681879ea0fda5fa1e9c3e3a4d5543aee.1741059516.git.gerickson@nuovations.com> |
Add documentation to the 'received_data' function.
---
gweb/gweb.c | 22 ++++++++++++++++++++++
1 file changed, 22 insertions(+)
diff --git a/gweb/gweb.c b/gweb/gweb.c
index ec72cd417a9c..78d4fb0517ff 100644
--- a/gweb/gweb.c
+++ b/gweb/gweb.c
@@ -1234,6 +1234,28 @@ static bool received_data_continue(struct web_session *session,
return TRUE;
}
+/**
+ * @brief
+ * Handle a glib I/O channel watch received data delegation for a
+ * web session request.
+ *
+ * This handles a glib I/O channel received data delegate for the web
+ * session request associated with @a channel.
+ *
+ * @param[in,out] channel A pointer to the glib channel that
+ * received data or a condition(s)/
+ * event(s).
+ * @param[in] cond The conditions or events that
+ * generated this delegation.
+ * @param[in,out] user_data A pointer to the mutable web session
+ * request associated with @a channel.
+ *
+ * @sa received_data_finalize
+ * @sa received_data_continue
+ *
+ * @private
+ *
+ */
static gboolean received_data(GIOChannel *channel, GIOCondition cond,
gpointer user_data)
{
--
2.45.0