[PATCH v2 04/22] gweb: Add documentation to 'g_web_result_has_headers'.
Grant Erickson <[email protected]>
| Newsgroups | dev.linux.lists.connman |
|---|---|
| Message-ID | <41b6aad1ec7965c887d03910babcb19f37d26c1b.1741059516.git.gerickson@nuovations.com> |
Add documentation to the 'g_web_result_has_headers' function.
---
gweb/gweb.c | 19 +++++++++++++++++++
1 file changed, 19 insertions(+)
diff --git a/gweb/gweb.c b/gweb/gweb.c
index 76f01c44b88f..d79d2d0808cd 100644
--- a/gweb/gweb.c
+++ b/gweb/gweb.c
@@ -2504,6 +2504,25 @@ bool g_web_result_get_header(GWebResult *result,
return true;
}
+/**
+ * @brief
+ * Return whether the web session request result has any HTTP
+ * headers.
+ *
+ * @param[in] result A pointer to the immutable web session
+ * request result for which to determine if there
+ * are any HTTP headers.
+ * @param[out] count An optional pointer to mutable storage for the
+ * number of HTTP headers associated with @a
+ * result.
+ *
+ * @returns
+ * True if there are one or more HTTP headers associated with @a
+ * result; otherwise, false.
+ *
+ * @sa g_web_result_get_header
+ *
+ */
bool g_web_result_has_headers(const GWebResult *result,
guint *count)
{
--
2.45.0