[PATCH v2 12/22] gweb: Add documentation to 'map_gerror'.
Grant Erickson <[email protected]>
| Newsgroups | dev.linux.lists.connman |
|---|---|
| Message-ID | <e2baa4014772fc6c9ca52543a4c2d10139776a7e.1741059516.git.gerickson@nuovations.com> |
Add documentation to the 'map_gerror' function.
---
gweb/gweb.c | 14 ++++++++++++++
1 file changed, 14 insertions(+)
diff --git a/gweb/gweb.c b/gweb/gweb.c
index 4a402ccfc346..12fe682cedfb 100644
--- a/gweb/gweb.c
+++ b/gweb/gweb.c
@@ -1130,6 +1130,20 @@ static void add_header_field(struct web_session *session)
}
}
+/**
+ * @brief
+ * Map a glib error into the negated POSIX error domain.
+ *
+ * This attempts to map the specfied glib error into the negated
+ * POSIX error domain, defaulting to -EIO for unmapped domain/code
+ * pairs.
+ *
+ * @param[in] error A pointer to the immutable glib error to map.
+ *
+ * @returns
+ * A mapped glib error into the negated POSIX error domain.
+ *
+ */
static int map_gerror(const GError *error)
{
int err;
--
2.45.0