diff options
| author | Neels Hofmeyr <nhofmeyr@sysmocom.de> | 2017-06-20 04:35:06 +0200 |
|---|---|---|
| committer | Neels Hofmeyr <nhofmeyr@sysmocom.de> | 2017-06-23 00:18:23 +0000 |
| commit | 17518fe393a37781c84d09836256bb1a6256032b (patch) | |
| tree | 6a39eb3b0b86fa7407ea04a00410aaa1b588d3d3 /utils | |
| parent | 33370cb18d3dda2bccbf2648f40d9614693ed0ea (diff) | |
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
Diffstat (limited to 'utils')
| -rw-r--r-- | utils/osmo-arfcn.c | 3 | ||||
| -rw-r--r-- | utils/osmo-auc-gen.c | 7 |
2 files changed, 6 insertions, 4 deletions
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 <laforge@gnumonks.org> * 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 <laforge@gnumonks.org> +/*! \file osmo-auc-gen.c + * GSM/GPRS/3G authentication testing tool. */ +/* + * (C) 2010-2012 by Harald Welte <laforge@gnumonks.org> * * All Rights Reserved * |