[PATCH v2 09/22] gweb: Add documentation to 'g_web_result_get_status'.
Grant Erickson <[email protected]>
| Newsgroups | dev.linux.lists.connman |
|---|---|
| Message-ID | <008c8a22cd569df0fb8c8f815d946b0bf730b419.1741059516.git.gerickson@nuovations.com> |
Add documentation to the 'g_web_result_get_status' function.
---
gweb/gweb.c | 15 +++++++++++++++
1 file changed, 15 insertions(+)
diff --git a/gweb/gweb.c b/gweb/gweb.c
index 0256d622e00a..ec72cd417a9c 100644
--- a/gweb/gweb.c
+++ b/gweb/gweb.c
@@ -2526,6 +2526,21 @@ int g_web_result_get_err(const GWebResult *result)
return result->err;
}
+/**
+ * @brief
+ * Returns the HTTP status code, if any, associated with the
+ * web session request result.
+ *
+ * @param[in] result A pointer to the immutable web session
+ * request result for which to return the
+ * HTTP status code.
+ *
+ * @returns
+ * The HTTP status code.
+ *
+ * @sa g_web_result_get_err
+ *
+ */
guint16 g_web_result_get_status(GWebResult *result)
{
if (!result)
--
2.45.0