[36/90] inet: Document '__connman_inet_table2string'.

Commit Message

Grant Erickson Dec. 6, 2023, 11:49 p.m. UTC

This adds documentation to the '__connman_inet_table2string'
function.
---
 src/inet.c | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

Patch

diff --git a/src/inet.c b/src/inet.c
index 3d40f8d09e82..74a5a78619b9 100644
--- a/src/inet.c
+++ b/src/inet.c
@@ -256,6 +256,23 @@  out:
 	return ret;
 }
 
+/**
+ *  @brief
+ *    Return a string describing a Linux Routing Netlink (rtnl)
+ *    routing table identifier.
+ *
+ *  This returns a null-terminated C string describing a Linux Routing
+ *  Netlink (rtnl) routing table identifier.
+ *
+ *  @param[in]  table_id   The Linux Routing Netlink (rtnl) routing
+ *                         table identifier for which to return a
+ *                         descriptive string.
+ *
+ *  @returns
+ *    A pointer to a immutable null-terminated C string describing @a
+ *    table_id on success; otherwise, an empty string ("").
+ *
+ */
 const char *__connman_inet_table2string(uint32_t table_id)
 {
 	switch (table_id) {