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/write_queue.c | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) (limited to 'src/write_queue.c') diff --git a/src/write_queue.c b/src/write_queue.c index d9297744..203815bb 100644 --- a/src/write_queue.c +++ b/src/write_queue.c @@ -1,4 +1,3 @@ -/* Generic write queue implementation */ /* * (C) 2010-2016 by Holger Hans Peter Freyther * (C) 2010 by On-Waves @@ -27,10 +26,9 @@ /*! \addtogroup write_queue * @{ - * write queue for writing \ref msgb to sockets/fd's - */ - -/*! \file write_queue.c */ + * Write queue for writing \ref msgb to sockets/fds. + * + * \file write_queue.c */ /*! Select loop function for write queue handling * \param[in] fd osmocom file descriptor -- cgit v1.2.3