[PATCH v3 06/18] gweb: Add documentation to 'call_result_func'.

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

diff --git a/gweb/gweb.c b/gweb/gweb.c
index ba3b62165f5e..e4dad4f95e42 100644
--- a/gweb/gweb.c
+++ b/gweb/gweb.c
@@ -165,6 +165,30 @@ static void _debug(GWeb *web, const char *file, const char *caller,
  */
 G_DEFINE_QUARK(g-web-error-quark, g_web_error)
 
+/**
+ *  @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]  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, guint16 status)
 {
 
-- 
2.45.0