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 --- utils/osmo-arfcn.c | 3 ++- utils/osmo-auc-gen.c | 7 ++++--- 2 files changed, 6 insertions(+), 4 deletions(-) (limited to 'utils') diff --git a/utils/osmo-arfcn.c b/utils/osmo-arfcn.c index 5103c97b..61108f8d 100644 --- a/utils/osmo-arfcn.c +++ b/utils/osmo-arfcn.c @@ -1,4 +1,5 @@ -/* Utility program for ARFCN / frequency calculations */ +/*! \file osmo-arfcn.c + * Utility program for ARFCN / frequency calculations. */ /* * (C) 2011 by Harald Welte * diff --git a/utils/osmo-auc-gen.c b/utils/osmo-auc-gen.c index 6b1e6239..76c49274 100644 --- a/utils/osmo-auc-gen.c +++ b/utils/osmo-auc-gen.c @@ -1,6 +1,7 @@ -/* GSM/GPRS/3G authentication testing tool */ - -/* (C) 2010-2012 by Harald Welte +/*! \file osmo-auc-gen.c + * GSM/GPRS/3G authentication testing tool. */ +/* + * (C) 2010-2012 by Harald Welte * * All Rights Reserved * -- cgit v1.2.3