[v2,09/22] gweb: Add documentation to 'g_web_result_get_status'.

Commit Message

Grant Erickson March 4, 2025, 3:39 a.m. UTC

Add documentation to the 'g_web_result_get_status' function.
---
 gweb/gweb.c | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

Patch

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)