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/gsm/a5.h | 10 +++------- include/osmocom/gsm/abis_nm.h | 8 +++----- include/osmocom/gsm/apn.h | 2 ++ include/osmocom/gsm/bitvec_gsm.h | 3 +-- include/osmocom/gsm/comp128.h | 4 ++-- include/osmocom/gsm/comp128v23.h | 4 ++-- include/osmocom/gsm/gan.h | 2 ++ include/osmocom/gsm/gea.h | 4 ++-- include/osmocom/gsm/gsm0341.h | 2 ++ include/osmocom/gsm/gsm0411_smc.h | 2 ++ include/osmocom/gsm/gsm0411_smr.h | 2 ++ include/osmocom/gsm/gsm0411_utils.h | 2 ++ include/osmocom/gsm/gsm0480.h | 2 ++ include/osmocom/gsm/gsm0502.h | 2 ++ include/osmocom/gsm/gsm0808.h | 4 +++- include/osmocom/gsm/gsm0808_utils.h | 4 +++- include/osmocom/gsm/gsm23003.h | 3 +++ include/osmocom/gsm/gsm48.h | 2 ++ include/osmocom/gsm/gsm48_ie.h | 2 ++ include/osmocom/gsm/gsm_utils.h | 3 ++- include/osmocom/gsm/gsup.h | 7 ++++--- include/osmocom/gsm/ipa.h | 2 ++ include/osmocom/gsm/kasumi.h | 4 ++-- include/osmocom/gsm/l1sap.h | 2 ++ include/osmocom/gsm/lapd_core.h | 8 ++++---- include/osmocom/gsm/lapdm.h | 4 +--- include/osmocom/gsm/meas_rep.h | 2 ++ include/osmocom/gsm/mncc.h | 2 ++ include/osmocom/gsm/oap.h | 7 ++++--- include/osmocom/gsm/prim.h | 2 ++ include/osmocom/gsm/protocol/gsm_03_40.h | 5 +++-- include/osmocom/gsm/protocol/gsm_03_41.h | 5 +++-- include/osmocom/gsm/protocol/gsm_04_08.h | 4 +++- include/osmocom/gsm/protocol/gsm_04_08_gprs.h | 2 ++ include/osmocom/gsm/protocol/gsm_04_11.h | 2 ++ include/osmocom/gsm/protocol/gsm_04_12.h | 5 +++-- include/osmocom/gsm/protocol/gsm_04_14.h | 2 ++ include/osmocom/gsm/protocol/gsm_04_80.h | 5 +++-- include/osmocom/gsm/protocol/gsm_08_58.h | 15 +++++++-------- include/osmocom/gsm/protocol/gsm_09_02.h | 5 +++-- include/osmocom/gsm/protocol/gsm_12_21.h | 14 +++++--------- include/osmocom/gsm/protocol/gsm_23_003.h | 2 ++ include/osmocom/gsm/protocol/gsm_44_318.h | 5 +++-- include/osmocom/gsm/protocol/ipaccess.h | 2 ++ include/osmocom/gsm/protocol/smpp34_osmocom.h | 4 +++- include/osmocom/gsm/rsl.h | 4 +--- include/osmocom/gsm/rxlev_stat.h | 2 ++ include/osmocom/gsm/sysinfo.h | 2 ++ include/osmocom/gsm/tlv.h | 3 +-- 49 files changed, 121 insertions(+), 74 deletions(-) (limited to 'include/osmocom/gsm') diff --git a/include/osmocom/gsm/a5.h b/include/osmocom/gsm/a5.h index 893fb026..fae3fdd4 100644 --- a/include/osmocom/gsm/a5.h +++ b/include/osmocom/gsm/a5.h @@ -1,6 +1,6 @@ +/*! \file gsm/a5.h + * Osmocom GSM A5 ciphering algorithm header. */ /* - * a5.h - * * Copyright (C) 2011 Sylvain Munaut * * All Rights Reserved @@ -29,11 +29,7 @@ /*! \defgroup a5 GSM A5 ciphering algorithm * @{ - */ - -/*! \file gsm/a5.h - * Osmocom GSM A5 ciphering algorithm header - */ + * \file a5.h */ /*! Converts a frame number into the 22 bit number used in A5/x * \param[in] fn The true framenumber diff --git a/include/osmocom/gsm/abis_nm.h b/include/osmocom/gsm/abis_nm.h index acddb7f4..e031ee10 100644 --- a/include/osmocom/gsm/abis_nm.h +++ b/include/osmocom/gsm/abis_nm.h @@ -1,14 +1,12 @@ #pragma once -/*! \defgroup oml A-bis OML - * @{ - */ - #include #include #include -/*! \file abis_nm.h */ +/*! \defgroup oml A-bis OML + * @{ + * \file abis_nm.h */ extern const char abis_nm_ipa_magic[13]; extern const char abis_nm_osmo_magic[12]; diff --git a/include/osmocom/gsm/apn.h b/include/osmocom/gsm/apn.h index b4ece3a2..8d353248 100644 --- a/include/osmocom/gsm/apn.h +++ b/include/osmocom/gsm/apn.h @@ -1,3 +1,5 @@ +/*! \file apn.h */ + #pragma once #include diff --git a/include/osmocom/gsm/bitvec_gsm.h b/include/osmocom/gsm/bitvec_gsm.h index 20741efa..32f0cd2f 100644 --- a/include/osmocom/gsm/bitvec_gsm.h +++ b/include/osmocom/gsm/bitvec_gsm.h @@ -5,8 +5,7 @@ /*! \defgroup bitvec helpers for GSM * @{ - */ -/*! \file bitvec_gsm.h */ + * \file bitvec_gsm.h */ void bitvec_add_range1024(struct bitvec *bv, const struct gsm48_range_1024 *r); diff --git a/include/osmocom/gsm/comp128.h b/include/osmocom/gsm/comp128.h index 8ff76b10..8626f4bb 100644 --- a/include/osmocom/gsm/comp128.h +++ b/include/osmocom/gsm/comp128.h @@ -1,5 +1,5 @@ -/* - * COMP128 header +/*! \file comp128.h + * COMP128 header. * * See comp128.c for details */ diff --git a/include/osmocom/gsm/comp128v23.h b/include/osmocom/gsm/comp128v23.h index 31d39335..affe8a21 100644 --- a/include/osmocom/gsm/comp128v23.h +++ b/include/osmocom/gsm/comp128v23.h @@ -1,5 +1,5 @@ -/* - * COMP128v23 header +/*! \file comp128v23.h + * COMP128v23 header. * * See comp128v23.c for details */ diff --git a/include/osmocom/gsm/gan.h b/include/osmocom/gsm/gan.h index 6f2b5351..efede1d3 100644 --- a/include/osmocom/gsm/gan.h +++ b/include/osmocom/gsm/gan.h @@ -1,3 +1,5 @@ +/*! \file gan.h */ + #pragma once #include diff --git a/include/osmocom/gsm/gea.h b/include/osmocom/gsm/gea.h index 3051101d..5c23d2ac 100644 --- a/include/osmocom/gsm/gea.h +++ b/include/osmocom/gsm/gea.h @@ -1,5 +1,5 @@ -/* - * GEA3 header +/*! \file gea.h + * GEA3 header. * * See gea.c for details */ diff --git a/include/osmocom/gsm/gsm0341.h b/include/osmocom/gsm/gsm0341.h index 29ba3e16..2fc83e4b 100644 --- a/include/osmocom/gsm/gsm0341.h +++ b/include/osmocom/gsm/gsm0341.h @@ -1,3 +1,5 @@ +/*! \file gsm0341.h */ + #pragma once #include diff --git a/include/osmocom/gsm/gsm0411_smc.h b/include/osmocom/gsm/gsm0411_smc.h index 89964fa1..0cd1f94a 100644 --- a/include/osmocom/gsm/gsm0411_smc.h +++ b/include/osmocom/gsm/gsm0411_smc.h @@ -1,3 +1,5 @@ +/*! \file gsm0411_smc.h */ + #pragma once #include diff --git a/include/osmocom/gsm/gsm0411_smr.h b/include/osmocom/gsm/gsm0411_smr.h index bc908a75..19f9c5da 100644 --- a/include/osmocom/gsm/gsm0411_smr.h +++ b/include/osmocom/gsm/gsm0411_smr.h @@ -1,3 +1,5 @@ +/*! \file gsm0411_smr.h */ + #pragma once #include diff --git a/include/osmocom/gsm/gsm0411_utils.h b/include/osmocom/gsm/gsm0411_utils.h index 70050105..1c51111e 100644 --- a/include/osmocom/gsm/gsm0411_utils.h +++ b/include/osmocom/gsm/gsm0411_utils.h @@ -1,3 +1,5 @@ +/*! \file gsm0411_utils.h */ + #pragma once #include diff --git a/include/osmocom/gsm/gsm0480.h b/include/osmocom/gsm/gsm0480.h index 6ca23e98..672ffe5e 100644 --- a/include/osmocom/gsm/gsm0480.h +++ b/include/osmocom/gsm/gsm0480.h @@ -1,3 +1,5 @@ +/*! \file gsm0480.h */ + #pragma once #include diff --git a/include/osmocom/gsm/gsm0502.h b/include/osmocom/gsm/gsm0502.h index 6ee5a600..fe5cf7e1 100644 --- a/include/osmocom/gsm/gsm0502.h +++ b/include/osmocom/gsm/gsm0502.h @@ -1,3 +1,5 @@ +/*! \file gsm0502.h */ + #pragma once #include diff --git a/include/osmocom/gsm/gsm0808.h b/include/osmocom/gsm/gsm0808.h index 9be229c6..4369cabe 100644 --- a/include/osmocom/gsm/gsm0808.h +++ b/include/osmocom/gsm/gsm0808.h @@ -1,4 +1,6 @@ -/* (C) 2009,2010 by Holger Hans Peter Freyther +/*! \file gsm0808.h */ +/* + * (C) 2009,2010 by Holger Hans Peter Freyther * (C) 2009,2010 by On-Waves * All Rights Reserved * diff --git a/include/osmocom/gsm/gsm0808_utils.h b/include/osmocom/gsm/gsm0808_utils.h index 0937630d..57ba1713 100644 --- a/include/osmocom/gsm/gsm0808_utils.h +++ b/include/osmocom/gsm/gsm0808_utils.h @@ -1,4 +1,6 @@ -/* (C) 2016 by Sysmocom s.f.m.c. GmbH +/*! \file gsm0808_utils.h */ +/* + * (C) 2016 by Sysmocom s.f.m.c. GmbH * All Rights Reserved * * Author: Philipp Maier diff --git a/include/osmocom/gsm/gsm23003.h b/include/osmocom/gsm/gsm23003.h index 29e646cc..2bc75837 100644 --- a/include/osmocom/gsm/gsm23003.h +++ b/include/osmocom/gsm/gsm23003.h @@ -1,4 +1,7 @@ +/*! \file gsm23003.h */ + #pragma once + #include /* 23.003 Chapter 12.1 */ diff --git a/include/osmocom/gsm/gsm48.h b/include/osmocom/gsm/gsm48.h index 6a52c2d8..424748ee 100644 --- a/include/osmocom/gsm/gsm48.h +++ b/include/osmocom/gsm/gsm48.h @@ -1,3 +1,5 @@ +/*! \file gsm48.h */ + #pragma once #include diff --git a/include/osmocom/gsm/gsm48_ie.h b/include/osmocom/gsm/gsm48_ie.h index 84454865..f7cc24ea 100644 --- a/include/osmocom/gsm/gsm48_ie.h +++ b/include/osmocom/gsm/gsm48_ie.h @@ -1,3 +1,5 @@ +/*! \file gsm48_ie.h */ + #pragma once #include diff --git a/include/osmocom/gsm/gsm_utils.h b/include/osmocom/gsm/gsm_utils.h index e76d9ee8..998f681e 100644 --- a/include/osmocom/gsm/gsm_utils.h +++ b/include/osmocom/gsm/gsm_utils.h @@ -1,4 +1,5 @@ -/* GSM utility functions, e.g. coding and decoding */ +/*! \file gsm_utils.h + * GSM utility functions, e.g. coding and decoding. */ /* * (C) 2008 by Daniel Willmann * (C) 2009 by Holger Hans Peter Freyther diff --git a/include/osmocom/gsm/gsup.h b/include/osmocom/gsm/gsup.h index 04b31d0b..886ea5da 100644 --- a/include/osmocom/gsm/gsup.h +++ b/include/osmocom/gsm/gsup.h @@ -1,6 +1,7 @@ -/* Osmocom Generic Subscriber Update Protocol message encoder/decoder */ - -/* (C) 2014 by sysmocom s.f.m.c. GmbH, Author: Jacob Erlbeck +/*! \file gsup.h + * Osmocom Generic Subscriber Update Protocol message encoder/decoder. */ +/* + * (C) 2014 by sysmocom s.f.m.c. GmbH, Author: Jacob Erlbeck * (C) 2016 by Harald Welte * All Rights Reserved * diff --git a/include/osmocom/gsm/ipa.h b/include/osmocom/gsm/ipa.h index cabee139..7e1d7237 100644 --- a/include/osmocom/gsm/ipa.h +++ b/include/osmocom/gsm/ipa.h @@ -1,3 +1,5 @@ +/*! \file ipa.h */ + #pragma once #include diff --git a/include/osmocom/gsm/kasumi.h b/include/osmocom/gsm/kasumi.h index 222aece8..d9de10b4 100644 --- a/include/osmocom/gsm/kasumi.h +++ b/include/osmocom/gsm/kasumi.h @@ -1,5 +1,5 @@ -/* - * KASUMI header +/*! \file kasumi.h + * KASUMI header. * * See kasumi.c for details * The parameters are described in TS 135 202. diff --git a/include/osmocom/gsm/l1sap.h b/include/osmocom/gsm/l1sap.h index 322c7ec1..01f61ced 100644 --- a/include/osmocom/gsm/l1sap.h +++ b/include/osmocom/gsm/l1sap.h @@ -1,3 +1,5 @@ +/*! \file l1sap.h */ + #pragma once #include diff --git a/include/osmocom/gsm/lapd_core.h b/include/osmocom/gsm/lapd_core.h index 8d3a0f81..cfc357a7 100644 --- a/include/osmocom/gsm/lapd_core.h +++ b/include/osmocom/gsm/lapd_core.h @@ -1,3 +1,6 @@ +/*! \file lapd_core.h + * primitive related stuff + */ #pragma once #include @@ -8,10 +11,7 @@ /*! \defgroup lapd LAPD implementation common part * @{ - */ - -/*! \file lapd_core.h - * primitive related stuff + * \file lapd_core.h */ /*! LAPD related primitives (L2<->L3 SAP)*/ diff --git a/include/osmocom/gsm/lapdm.h b/include/osmocom/gsm/lapdm.h index ec14cddc..e01d065a 100644 --- a/include/osmocom/gsm/lapdm.h +++ b/include/osmocom/gsm/lapdm.h @@ -5,9 +5,7 @@ /*! \defgroup lapdm LAPDm implementation according to GSM TS 04.06 * @{ - */ - -/*! \file lapdm.h */ + * \file lapdm.h */ /*! LAPDm mode/role */ enum lapdm_mode { diff --git a/include/osmocom/gsm/meas_rep.h b/include/osmocom/gsm/meas_rep.h index 90c981dd..79f9f06b 100644 --- a/include/osmocom/gsm/meas_rep.h +++ b/include/osmocom/gsm/meas_rep.h @@ -1,3 +1,5 @@ +/*! \file meas_rep.h */ + #pragma once #include diff --git a/include/osmocom/gsm/mncc.h b/include/osmocom/gsm/mncc.h index 171db7ab..f2450d9c 100644 --- a/include/osmocom/gsm/mncc.h +++ b/include/osmocom/gsm/mncc.h @@ -1,3 +1,5 @@ +/*! \file mncc.h */ + #pragma once #include diff --git a/include/osmocom/gsm/oap.h b/include/osmocom/gsm/oap.h index fba22c78..ef83b794 100644 --- a/include/osmocom/gsm/oap.h +++ b/include/osmocom/gsm/oap.h @@ -1,6 +1,7 @@ -/* Osmocom Authentication Protocol message encoder/decoder */ - -/* (C) 2015-2016 by sysmocom s.f.m.c. GmbH +/*! \file oap.h + * Osmocom Authentication Protocol message encoder/decoder. */ +/* + * (C) 2015-2016 by sysmocom s.f.m.c. GmbH * All Rights Reserved * * Author: Neels Hofmeyr diff --git a/include/osmocom/gsm/prim.h b/include/osmocom/gsm/prim.h index 5f61dc7c..386b7d89 100644 --- a/include/osmocom/gsm/prim.h +++ b/include/osmocom/gsm/prim.h @@ -1,3 +1,5 @@ +/*! \file prim.h */ + #pragma once #include diff --git a/include/osmocom/gsm/protocol/gsm_03_40.h b/include/osmocom/gsm/protocol/gsm_03_40.h index 32d5c2c2..a65203f9 100644 --- a/include/osmocom/gsm/protocol/gsm_03_40.h +++ b/include/osmocom/gsm/protocol/gsm_03_40.h @@ -1,6 +1,7 @@ -#pragma once +/*! \file gsm_03_40.h + * GSM TS 03.40. */ -/* GSM TS 03.40 */ +#pragma once /** * 9.1.2.5 Type Of Number diff --git a/include/osmocom/gsm/protocol/gsm_03_41.h b/include/osmocom/gsm/protocol/gsm_03_41.h index 40051cd4..2e0ad69f 100644 --- a/include/osmocom/gsm/protocol/gsm_03_41.h +++ b/include/osmocom/gsm/protocol/gsm_03_41.h @@ -1,3 +1,6 @@ +/*! \file gsm_03_41.h + * GSM TS 03.41 definitions also TS 23.041. */ + #pragma once #include @@ -9,8 +12,6 @@ #define OSMO_IS_LITTLE_ENDIAN 0 #endif -/* GSM TS 03.41 definitions also TS 23.041*/ - #define GSM341_MAX_PAYLOAD (GSM412_MSG_LEN-sizeof(struct gsm341_ms_message)) #define GSM341_MAX_CHARS (GSM341_MAX_PAYLOAD*8/7) #define GSM341_7BIT_PADDING '\r' diff --git a/include/osmocom/gsm/protocol/gsm_04_08.h b/include/osmocom/gsm/protocol/gsm_04_08.h index 90b6cf15..643f0464 100644 --- a/include/osmocom/gsm/protocol/gsm_04_08.h +++ b/include/osmocom/gsm/protocol/gsm_04_08.h @@ -1,3 +1,6 @@ +/*! \file gsm_04_08.h + * GSM TS 04.08 definitions. */ + #pragma once #include @@ -6,7 +9,6 @@ #include #include -/* GSM TS 04.08 definitions */ struct gsm_lchan; /* Chapter 10.5.1.5 */ diff --git a/include/osmocom/gsm/protocol/gsm_04_08_gprs.h b/include/osmocom/gsm/protocol/gsm_04_08_gprs.h index def8dfcd..13820a78 100644 --- a/include/osmocom/gsm/protocol/gsm_04_08_gprs.h +++ b/include/osmocom/gsm/protocol/gsm_04_08_gprs.h @@ -1,3 +1,5 @@ +/*! \file gsm_04_08_gprs.h */ + #ifndef _GSM48_GPRS_H #define _GSM48_GPRS_H diff --git a/include/osmocom/gsm/protocol/gsm_04_11.h b/include/osmocom/gsm/protocol/gsm_04_11.h index 651adcaa..31f25acb 100644 --- a/include/osmocom/gsm/protocol/gsm_04_11.h +++ b/include/osmocom/gsm/protocol/gsm_04_11.h @@ -1,3 +1,5 @@ +/*! \file gsm_04_11.h */ + #pragma once #include diff --git a/include/osmocom/gsm/protocol/gsm_04_12.h b/include/osmocom/gsm/protocol/gsm_04_12.h index 30d6e4fa..826e69bd 100644 --- a/include/osmocom/gsm/protocol/gsm_04_12.h +++ b/include/osmocom/gsm/protocol/gsm_04_12.h @@ -1,9 +1,10 @@ +/*! \file gsm_04_12.h + * GSM TS 04.12 definitions for Short Message Service Cell Broadcast. */ + #pragma once #include -/* GSM TS 04.12 definitions for Short Message Service Cell Broadcast */ - #define GSM412_MSG_LEN 88 /* TS 04.12 Section 3.1 */ #define GSM412_BLOCK_LEN 22 /* TS 04.12 Section 3.1 */ diff --git a/include/osmocom/gsm/protocol/gsm_04_14.h b/include/osmocom/gsm/protocol/gsm_04_14.h index 421b56f1..6f7d92c9 100644 --- a/include/osmocom/gsm/protocol/gsm_04_14.h +++ b/include/osmocom/gsm/protocol/gsm_04_14.h @@ -1,3 +1,5 @@ +/*! \file gsm_04_14.h */ + #pragma once #include diff --git a/include/osmocom/gsm/protocol/gsm_04_80.h b/include/osmocom/gsm/protocol/gsm_04_80.h index 2aebb46e..e204c50d 100644 --- a/include/osmocom/gsm/protocol/gsm_04_80.h +++ b/include/osmocom/gsm/protocol/gsm_04_80.h @@ -1,6 +1,7 @@ -#pragma once +/*! \file gsm_04_80.h + * GSM TS 04.80 definitions (Supplementary Services Specification, Formats and Coding). */ -/* GSM TS 04.80 definitions (Supplementary Services Specification, Formats and Coding) */ +#pragma once /* Section 3.4 */ #define GSM0480_MTYPE_RELEASE_COMPLETE 0x2A diff --git a/include/osmocom/gsm/protocol/gsm_08_58.h b/include/osmocom/gsm/protocol/gsm_08_58.h index c76cf3b1..bc70b930 100644 --- a/include/osmocom/gsm/protocol/gsm_08_58.h +++ b/include/osmocom/gsm/protocol/gsm_08_58.h @@ -1,9 +1,8 @@ -#pragma once - -/* GSM Radio Signalling Link messages on the A-bis interface +/*! \file gsm_08_58.h + * GSM Radio Signalling Link messages on the A-bis interface. * 3GPP TS 08.58 version 8.6.0 Release 1999 / ETSI TS 100 596 V8.6.0 */ - -/* (C) 2008 by Harald Welte +/* + * (C) 2008 by Harald Welte * All Rights Reserved * * This program is free software; you can redistribute it and/or modify @@ -22,13 +21,13 @@ * */ +#pragma once + #include /*! \addtogroup rsl * @{ - */ - -/*! \file gsm_08_58.h */ + * \file gsm_08_58.h */ /*! RSL common header */ struct abis_rsl_common_hdr { diff --git a/include/osmocom/gsm/protocol/gsm_09_02.h b/include/osmocom/gsm/protocol/gsm_09_02.h index 3f68b457..0b54fb74 100644 --- a/include/osmocom/gsm/protocol/gsm_09_02.h +++ b/include/osmocom/gsm/protocol/gsm_09_02.h @@ -1,8 +1,9 @@ +/*! \file gsm_09_02.h + * GSM TS 09.02 definitions (MAP). */ + #ifndef PROTO_GSM_09_02_H #define PROTO_GSM_09_02_H -/* GSM TS 09.02 definitions (MAP) */ - /* Section 17.7.4 */ /* SS-Status */ #define GSM0902_SS_STATUS_Q_BIT 0x08 diff --git a/include/osmocom/gsm/protocol/gsm_12_21.h b/include/osmocom/gsm/protocol/gsm_12_21.h index 1bdee9cd..3ef36038 100644 --- a/include/osmocom/gsm/protocol/gsm_12_21.h +++ b/include/osmocom/gsm/protocol/gsm_12_21.h @@ -1,9 +1,5 @@ -#pragma once - -/* GSM Network Management messages on the A-bis interface - * 3GPP TS 12.21 version 8.0.0 Release 1999 / ETSI TS 100 623 V8.0.0 */ - -/* (C) 2008-2009 by Harald Welte +/* + * (C) 2008-2009 by Harald Welte * All Rights Reserved * * This program is free software; you can redistribute it and/or modify @@ -22,11 +18,11 @@ * */ +#pragma once + /*! \addtogroup oml * @{ - */ - -/*! \file gsm_12_21.h */ + * \file gsm_12_21.h */ #include #include diff --git a/include/osmocom/gsm/protocol/gsm_23_003.h b/include/osmocom/gsm/protocol/gsm_23_003.h index a2109b60..94243feb 100644 --- a/include/osmocom/gsm/protocol/gsm_23_003.h +++ b/include/osmocom/gsm/protocol/gsm_23_003.h @@ -1,3 +1,5 @@ +/*! \file gsm_23_003.h */ + #pragma once /* Chapter 2.2 */ diff --git a/include/osmocom/gsm/protocol/gsm_44_318.h b/include/osmocom/gsm/protocol/gsm_44_318.h index 5d7f8787..76e8396c 100644 --- a/include/osmocom/gsm/protocol/gsm_44_318.h +++ b/include/osmocom/gsm/protocol/gsm_44_318.h @@ -1,9 +1,10 @@ +/*! \file gsm_44_318.h + * Definitions according to 3GPP TS 44.318 6.8.0 Release 6. */ + #pragma once #include -/* Definitions according to 3GPP TS 44.318 6.8.0 Release 6 */ - /* Table 11.1.1.2.1: Protocol Discriminator */ enum gan_pdisc { GA_PDISC_RC = 0, diff --git a/include/osmocom/gsm/protocol/ipaccess.h b/include/osmocom/gsm/protocol/ipaccess.h index ba6cb3be..0f5d54f2 100644 --- a/include/osmocom/gsm/protocol/ipaccess.h +++ b/include/osmocom/gsm/protocol/ipaccess.h @@ -1,3 +1,5 @@ +/*! \file ipaccess.h */ + #pragma once #include diff --git a/include/osmocom/gsm/protocol/smpp34_osmocom.h b/include/osmocom/gsm/protocol/smpp34_osmocom.h index cff6adba..7c72ac84 100644 --- a/include/osmocom/gsm/protocol/smpp34_osmocom.h +++ b/include/osmocom/gsm/protocol/smpp34_osmocom.h @@ -1,5 +1,7 @@ +/*! \file smpp34_osmocom.h + * Osmocom SMPP extensions. */ + #pragma once -/* Osmocom SMPP extensions */ /* Osmocom specific new TLV definitions */ diff --git a/include/osmocom/gsm/rsl.h b/include/osmocom/gsm/rsl.h index 93e27a14..3d9c66f5 100644 --- a/include/osmocom/gsm/rsl.h +++ b/include/osmocom/gsm/rsl.h @@ -7,9 +7,7 @@ /*! \defgroup rsl RSL * @{ - */ - -/*! \file rsl.h */ + * \file rsl.h */ void rsl_init_rll_hdr(struct abis_rsl_rll_hdr *dh, uint8_t msg_type); diff --git a/include/osmocom/gsm/rxlev_stat.h b/include/osmocom/gsm/rxlev_stat.h index 7183b173..7aa35cd5 100644 --- a/include/osmocom/gsm/rxlev_stat.h +++ b/include/osmocom/gsm/rxlev_stat.h @@ -1,3 +1,5 @@ +/*! \file rxlev_stat.h */ + #pragma once #define NUM_RXLEVS 32 diff --git a/include/osmocom/gsm/sysinfo.h b/include/osmocom/gsm/sysinfo.h index f3e0f22f..8e26f996 100644 --- a/include/osmocom/gsm/sysinfo.h +++ b/include/osmocom/gsm/sysinfo.h @@ -1,3 +1,5 @@ +/*! \file sysinfo.h */ + #pragma once #include diff --git a/include/osmocom/gsm/tlv.h b/include/osmocom/gsm/tlv.h index fa3b6564..c3568400 100644 --- a/include/osmocom/gsm/tlv.h +++ b/include/osmocom/gsm/tlv.h @@ -9,8 +9,7 @@ /*! \defgroup tlv GSM L3 compatible TLV parser * @{ - */ -/*! \file tlv.h */ + * \file tlv.h */ /* Terminology / wording tag length value (in bits) -- cgit v1.2.3