[doc] Don't add libosmovty bits to libosmocore groups
Let's not put files of libosmovty into Doxygen groups of libosmocore,
as this seems to confuse Doxygen. Also, some minor updates/fixes
of libosmovty documentation.
Change-Id: I70e612b8d06aabefe634fcd7861641ffb941d974
diff --git a/src/vty/telnet_interface.c b/src/vty/telnet_interface.c
index f82a7ff..40154fe 100644
--- a/src/vty/telnet_interface.c
+++ b/src/vty/telnet_interface.c
@@ -1,5 +1,3 @@
-/*! \file telnet_interface.c
- * minimalistic telnet/network interface it might turn into a wire interface */
/* (C) 2009 by Holger Hans Peter Freyther <zecke@selfish.org>
* All Rights Reserved
*
@@ -37,8 +35,7 @@
#include <osmocom/vty/buffer.h>
#include <osmocom/vty/command.h>
-/*! \addtogroup telnet_interface
- * @{
+/*! \file telnet_interface.c
* Telnet interface towards Osmocom VTY
*
* This module contains the code implementing a telnet server for VTY
@@ -46,7 +43,9 @@
* process in order to enable interactive command-line introspection,
* interaction and configuration.
*
- * \file telnet_interface.c */
+ * You typically call \ref telnet_init or \ref telnet_init_dynif once
+ * from your application code to enable this.
+ */
/* per connection data */
LLIST_HEAD(active_connections);
@@ -219,6 +218,7 @@
}
}
+/*! Close all telnet connections and release the telnet socket */
void telnet_exit(void)
{
struct telnet_connection *tc, *tc2;
@@ -230,5 +230,3 @@
close(server_socket.fd);
talloc_free(tall_telnet_ctx);
}
-
-/*! @} */