From 17518fe393a37781c84d09836256bb1a6256032b Mon Sep 17 00:00:00 2001 From: Neels Hofmeyr Date: Tue, 20 Jun 2017 04:35:06 +0200 Subject: doxygen: unify use of \file across the board Considering the various styles and implications found in the sources, edit scores of files to follow the same API doc guidelines around the doxygen grouping and the \file tag. Many files now show a short description in the generated API doc that was so far only available as C comment. The guidelines and reasoning behind it is documented at https://osmocom.org/projects/cellular-infrastructure/wiki/Guidelines_for_API_documentation In some instances, remove file comments and add to the corresponding group instead, to be shared among several files (e.g. bitvec). Change-Id: Ifa70e77e90462b5eb2b0457c70fd25275910c72b --- src/vty/telnet_interface.c | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) (limited to 'src/vty/telnet_interface.c') diff --git a/src/vty/telnet_interface.c b/src/vty/telnet_interface.c index d59516c1..f82a7ff1 100644 --- a/src/vty/telnet_interface.c +++ b/src/vty/telnet_interface.c @@ -1,4 +1,5 @@ -/* minimalistic telnet/network interface it might turn into a wire interface */ +/*! \file telnet_interface.c + * minimalistic telnet/network interface it might turn into a wire interface */ /* (C) 2009 by Holger Hans Peter Freyther * All Rights Reserved * @@ -44,8 +45,8 @@ * 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 */ + * + * \file telnet_interface.c */ /* per connection data */ LLIST_HEAD(active_connections); -- cgit v1.2.3