diff options
| author | Harald Welte <laforge@gnumonks.org> | 2017-10-16 15:17:03 +0200 |
|---|---|---|
| committer | Harald Welte <laforge@gnumonks.org> | 2017-10-16 15:17:03 +0200 |
| commit | 8c64825249e46409c982b1e2bf4148f0bc860446 (patch) | |
| tree | c0167eb38da7d06559d9825a6bebe3f1551218da /src/vty/telnet_interface.c | |
| parent | 7166094a85b88bdf18f19ea1e3a85874c0236748 (diff) | |
[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
Diffstat (limited to 'src/vty/telnet_interface.c')
| -rw-r--r-- | src/vty/telnet_interface.c | 12 |
1 files changed, 5 insertions, 7 deletions
diff --git a/src/vty/telnet_interface.c b/src/vty/telnet_interface.c index f82a7ff1..40154fef 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 @@ void vty_event(enum event event, int sock, struct vty *vty) } } +/*! Close all telnet connections and release the telnet socket */ void telnet_exit(void) { struct telnet_connection *tc, *tc2; @@ -230,5 +230,3 @@ void telnet_exit(void) close(server_socket.fd); talloc_free(tall_telnet_ctx); } - -/*! @} */ |