From 96e2a00d7a9044d0b1a83909c11d8f24955bc7c8 Mon Sep 17 00:00:00 2001 From: Harald Welte Date: Mon, 12 Jun 2017 21:44:18 +0200 Subject: update/extend doxygen documentation It's a pity that even with this patch we still are fare away from having the whole API documented. However, at least we have a more solid foundation. Updates not only extend the documentation, but also make sure it is rendered properly in the doxygen HTML. Change-Id: I1344bd1a6869fb00de7c1899a8db93bba9bafce3 --- src/vty/telnet_interface.c | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'src/vty/telnet_interface.c') diff --git a/src/vty/telnet_interface.c b/src/vty/telnet_interface.c index 218f9abf..d53881a1 100644 --- a/src/vty/telnet_interface.c +++ b/src/vty/telnet_interface.c @@ -38,6 +38,12 @@ /*! \addtogroup telnet_interface * @{ + * \brief Telnet interface towards Osmocom VTY + * + * This module contains the code implementing a telnet server for VTY + * access. This telnet server gets linked into each libosmovty-using + * process in order to enable interactive command-line introspection, + * interaction and configuration. */ /*! \file telnet_interface.c */ -- cgit v1.2.3