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 --- include/osmocom/core/defs.h | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'include/osmocom/core/defs.h') diff --git a/include/osmocom/core/defs.h b/include/osmocom/core/defs.h index 88c41b91..5e5aa90f 100644 --- a/include/osmocom/core/defs.h +++ b/include/osmocom/core/defs.h @@ -1,12 +1,12 @@ +/*! \file defs.h + * General definitions that are meant to be included from header files. + */ + #pragma once /*! \defgroup utils General-purpose utility functions * @{ - */ - -/*! \file defs.h - * General definitions that are meant to be included from header files. - */ + * \file defs.h */ /*! Check for gcc and version. * -- cgit v1.2.3