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 /include | |
| 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 'include')
119 files changed, 335 insertions, 309 deletions
diff --git a/include/osmocom/codec/codec.h b/include/osmocom/codec/codec.h index 3e9b6881..3e62a013 100644 --- a/include/osmocom/codec/codec.h +++ b/include/osmocom/codec/codec.h @@ -1,3 +1,5 @@ +/*! \file codec.h */ + #pragma once #include <stdint.h> diff --git a/include/osmocom/coding/gsm0503_coding.h b/include/osmocom/coding/gsm0503_coding.h index a9c59e47..a2d4115b 100644 --- a/include/osmocom/coding/gsm0503_coding.h +++ b/include/osmocom/coding/gsm0503_coding.h @@ -1,3 +1,7 @@ +/*! \file gsm0503_coding.h + * GSM TS 05.03 coding + */ + #pragma once #include <stdint.h> @@ -5,11 +9,7 @@ /*! \addtogroup coding * @{ - */ - -/*! \file gsm0503_coding.h - * GSM TS 05.03 coding - */ + * \file gsm0503_coding.h */ #define GSM0503_GPRS_BURSTS_NBITS (116 * 4) #define GSM0503_EGPRS_BURSTS_NBITS (348 * 4) diff --git a/include/osmocom/coding/gsm0503_interleaving.h b/include/osmocom/coding/gsm0503_interleaving.h index 1463fb38..05b5e278 100644 --- a/include/osmocom/coding/gsm0503_interleaving.h +++ b/include/osmocom/coding/gsm0503_interleaving.h @@ -1,14 +1,14 @@ +/*! \file gsm0503_interleaving.h + * GSM TS 05.03 interleaving. + */ + #pragma once #include <osmocom/core/bits.h> /*! \addtogroup interleaving * @{ - */ - -/*! \file gsm0503_interleaving.h - * GSM TS 05.03 interleaving - */ + * \file gsm0503_interleaving.h */ void gsm0503_xcch_deinterleave(sbit_t *cB, const sbit_t *iB); void gsm0503_xcch_interleave(const ubit_t *cB, ubit_t *iB); diff --git a/include/osmocom/coding/gsm0503_mapping.h b/include/osmocom/coding/gsm0503_mapping.h index 435c9131..fbd3bfd7 100644 --- a/include/osmocom/coding/gsm0503_mapping.h +++ b/include/osmocom/coding/gsm0503_mapping.h @@ -1,14 +1,14 @@ +/*! \file gsm0503_mapping.c + * GSM TS 05.03 burst mapping. + */ + #pragma once #include <osmocom/core/bits.h> /*! \addtogroup mapping * @{ - */ - -/*! \file gsm0503_mapping.c - * GSM TS 05.03 burst mapping - */ + * \file gsm0503_mapping.h */ void gsm0503_xcch_burst_unmap(sbit_t *iB, const sbit_t *eB, sbit_t *hl, sbit_t *hn); diff --git a/include/osmocom/coding/gsm0503_parity.h b/include/osmocom/coding/gsm0503_parity.h index 2743bdb1..28a54443 100644 --- a/include/osmocom/coding/gsm0503_parity.h +++ b/include/osmocom/coding/gsm0503_parity.h @@ -1,14 +1,14 @@ +/*! \file gsm0503_parity.h + * GSM TS 05.03 parity. + */ + #pragma once #include <osmocom/core/crcgen.h> /*! \addtogroup parity * @{ - */ - -/*! \file gsm0503_parity.h - * GSM TS 05.03 parity - */ + * \file gsm0503_parity.h */ const struct osmo_crc64gen_code gsm0503_fire_crc40; const struct osmo_crc16gen_code gsm0503_cs234_crc16; diff --git a/include/osmocom/cod |