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/bits.c | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) (limited to 'src/bits.c') diff --git a/src/bits.c b/src/bits.c index 45ac8e24..af09441a 100644 --- a/src/bits.c +++ b/src/bits.c @@ -26,11 +26,9 @@ /*! \addtogroup bits * @{ - * Osmocom bit level support code - */ - -/*! \file bits.c */ - + * Osmocom bit level support code. + * + * \file bits.c */ /*! convert unpacked bits to packed bits, return length in bytes * \param[out] out output buffer of packed bits -- cgit v1.2.3