doxygen: Add (partial) VTY API documentation
diff --git a/src/vty/telnet_interface.c b/src/vty/telnet_interface.c
index 1a28510..89cba58 100644
--- a/src/vty/telnet_interface.c
+++ b/src/vty/telnet_interface.c
@@ -33,6 +33,11 @@
#include <osmocom/vty/buffer.h>
#include <osmocom/vty/command.h>
+/*! \addtogroup vty
+ * @{
+ */
+/*! \file telnet_interface.c */
+
/* per connection data */
LLIST_HEAD(active_connections);
@@ -47,6 +52,11 @@
.priv_nr = 0,
};
+/*! \brief Initialize telnet based VTY interface
+ * \param[in] tall_ctx \ref talloc context
+ * \param[in] priv private data to be passed to callback
+ * \param[in] port UDP port number
+ */
int telnet_init(void *tall_ctx, void *priv, int port)
{
struct sockaddr_in sock_addr;
@@ -55,6 +65,7 @@
tall_telnet_ctx = talloc_named_const(tall_ctx, 1,
"telnet_connection");
+ /* FIXME: use new socket.c code of libosmocore */
fd = socket(PF_INET, SOCK_STREAM, IPPROTO_TCP);
if (fd < 0) {
@@ -109,6 +120,7 @@
write(fd, host.app_info->copyright, strlen(host.app_info->copyright));
}
+/*! \brief close a telnet connection */
int telnet_close_client(struct osmo_fd *fd)
{
struct telnet_connection *conn = (struct telnet_connection*)fd->data;
@@ -183,7 +195,7 @@
return 0;
}
-/* callback from VTY code */
+/*! \brief callback from core VTY code about VTY related events */
void vty_event(enum event event, int sock, struct vty *vty)
{
struct telnet_connection *connection = vty->priv;
@@ -209,3 +221,4 @@
}
}
+/*! }@ */