doxygen: enable AUTOBRIEF, drop \brief
Especially for short descriptions, it is annoying to have to type \brief for
every single API doc.
Drop all \brief and enable the AUTOBRIEF feature of doxygen, which always takes
the first sentence of an API doc as the brief description.
Change-Id: I11a8a821b065a128108641a2a63fb5a2b1916e87
diff --git a/include/osmocom/gsm/protocol/gsm_04_08.h b/include/osmocom/gsm/protocol/gsm_04_08.h
index 604a5df..90b6cf1 100644
--- a/include/osmocom/gsm/protocol/gsm_04_08.h
+++ b/include/osmocom/gsm/protocol/gsm_04_08.h
@@ -957,7 +957,7 @@
#define GSM48_TA_INVALID 220
-/*! \brief Check if TA is valid according to 3GPP TS 44.018 § 10.5.2.40
+/*! Check if TA is valid according to 3GPP TS 44.018 § 10.5.2.40
* \param[in] ta Timing Advance value
* \returns true if ta is valid, false otherwise
* Note: Rules for GSM400 band are ignored as it's not implemented in practice.
@@ -1620,7 +1620,7 @@
GSM48_BCAP_MT_AUTO_1 = 8,
};
-/*! \brief GSM 04.08 Bearer Capability: Speech Version Indication
+/*! GSM 04.08 Bearer Capability: Speech Version Indication
* (See also 3GPP TS 24.008, Table 10.5.103) */
enum gsm48_bcap_speech_ver {
GSM48_BCAP_SV_FR = 0, /*!< GSM FR V1 (GSM FR) */
diff --git a/include/osmocom/gsm/protocol/gsm_08_08.h b/include/osmocom/gsm/protocol/gsm_08_08.h
index d165330..6ae6855 100644
--- a/include/osmocom/gsm/protocol/gsm_08_08.h
+++ b/include/osmocom/gsm/protocol/gsm_08_08.h
@@ -391,7 +391,7 @@
GSM0808_SPEECH_PERM_NO_CHANGE = 0x1f,
};
-/*! \brief GSM 08.08 3.2.2.11 Channel Type
+/*! GSM 08.08 3.2.2.11 Channel Type
* (see also 3GPP TS 48.008, section 3.2.2.11) */
enum gsm0808_permitted_speech {
GSM0808_PERM_FR1 = 0x01, /*!< GSM FR */
@@ -406,7 +406,7 @@
GSM0808_PERM_HR6 = 0x45, /*!< OHR AMR */
};
-/*! \brief 3GPP TS 48.008, 3.2.2.103 Speech Codec Type */
+/*! 3GPP TS 48.008, 3.2.2.103 Speech Codec Type */
enum gsm0808_speech_codec_type {
GSM0808_SCT_FR1 = 0x0, /*!< GSM FR */
GSM0808_SCT_FR2 = 0x2, /*!< GSM EFR */
@@ -449,7 +449,7 @@
uint16_t cfg;
};
-/*! \brief Default speech codec configurations: Some codecs specified with
+/*! Default speech codec configurations: Some codecs specified with
* struct gsm0808_speech_codec, require a configuration (cfg). The following
* default configuration will configure the codec (RTP) to match the
* configuration that is used on the air interface (Um).
diff --git a/include/osmocom/gsm/protocol/gsm_08_58.h b/include/osmocom/gsm/protocol/gsm_08_58.h
index a7a2ccf..c76cf3b 100644
--- a/include/osmocom/gsm/protocol/gsm_08_58.h
+++ b/include/osmocom/gsm/protocol/gsm_08_58.h
@@ -30,59 +30,59 @@
/*! \file gsm_08_58.h */
-/*! \brief RSL common header */
+/*! RSL common header */
struct abis_rsl_common_hdr {
- uint8_t msg_discr; /*!< \brief message discriminator (ABIS_RSL_MDISC_*) */
- uint8_t msg_type; /*!< \brief message type (\ref abis_rsl_msgtype) */
- uint8_t data[0]; /*!< \brief actual payload data */
+ uint8_t msg_discr; /*!< message discriminator (ABIS_RSL_MDISC_*) */
+ uint8_t msg_type; /*!< message type (\ref abis_rsl_msgtype) */
+ uint8_t data[0]; /*!< actual payload data */
} __attribute__ ((packed));
-/* \brief RSL RLL header (Chapter 8.3) */
+/* RSL RLL header (Chapter 8.3) */
struct abis_rsl_rll_hdr {
struct abis_rsl_common_hdr c;
- uint8_t ie_chan; /*!< \brief \ref RSL_IE_CHAN_NR (tag) */
- uint8_t chan_nr; /*!< \brief RSL channel number (value) */
- uint8_t ie_link_id; /*!< \brief \ref RSL_IE_LINK_IDENT (tag) */
- uint8_t link_id; /*!< \brief RSL link identifier (value) */
- uint8_t data[0]; /*!< \brief message payload data */
+ uint8_t ie_chan; /*!< \ref RSL_IE_CHAN_NR (tag) */
+ uint8_t chan_nr; /*!< RSL channel number (value) */
+ uint8_t ie_link_id; /*!< \ref RSL_IE_LINK_IDENT (tag) */
+ uint8_t link_id; /*!< RSL link identifier (value) */
+ uint8_t data[0]; /*!< message payload data */
} __attribute__ ((packed));
-/* \brief RSL Dedicated Channel header (Chapter 8.3 and 8.4) */
+/* RSL Dedicated Channel header (Chapter 8.3 and 8.4) */
struct abis_rsl_dchan_hdr {
struct abis_rsl_common_hdr c;
- uint8_t ie_chan; /*!< \brief \ref RSL_IE_CHAN_NR (tag) */
- uint8_t chan_nr; /*!< \brief RSL channel number (value) */
- uint8_t data[0]; /*!< \brief message payload data */
+ uint8_t ie_chan; /*!< \ref RSL_IE_CHAN_NR (tag) */
+ uint8_t chan_nr; /*!< RSL channel number (value) */
+ uint8_t data[0]; /*!< message payload data */
} __attribute__ ((packed));
-/* \brief RSL Common Channel header (Chapter 8.5) */
+/* RSL Common Channel header (Chapter 8.5) */
struct abis_rsl_cchan_hdr {
struct abis_rsl_common_hdr c;
- uint8_t ie_chan; /*!< \brief \ref RSL_IE_CHAN_NR (tag) */
- uint8_t chan_nr; /*!< \brief RSL channel number (value) */
- uint8_t data[0]; /*!< \brief message payload data */
+ uint8_t ie_chan; /*!< \ref RSL_IE_CHAN_NR (tag) */
+ uint8_t chan_nr; /*!< RSL channel number (value) */
+ uint8_t data[0]; /*!< message payload data */
} __attribute__ ((packed));
/* Chapter 9.1 */
-/* \brief RSL Message Discriminator: RLL */
+/* RSL Message Discriminator: RLL */
#define ABIS_RSL_MDISC_RLL 0x02
-/* \brief RSL Message Discriminator: Dedicated Channel */
+/* RSL Message Discriminator: Dedicated Channel */
#define ABIS_RSL_MDISC_DED_CHAN 0x08
-/* \brief RSL Message Discriminator: Common Channel */
+/* RSL Message Discriminator: Common Channel */
#define ABIS_RSL_MDISC_COM_CHAN 0x0c
-/* \brief RSL Message Discriminator: TRX Management */
+/* RSL Message Discriminator: TRX Management */
#define ABIS_RSL_MDISC_TRX 0x10
-/* \brief RSL Message Discriminator: Location Service */
+/* RSL Message Discriminator: Location Service */
#define ABIS_RSL_MDISC_LOC 0x20
-/* \brief RSL Message Discriminator: ip.access */
+/* RSL Message Discriminator: ip.access */
#define ABIS_RSL_MDISC_IPACCESS 0x7e
#define ABIS_RSL_MDISC_TRANSP 0x01
-/* \brief Check if given RSL message discriminator is transparent */
+/* Check if given RSL message discriminator is transparent */
#define ABIS_RSL_MDISC_IS_TRANSP(x) (x & 0x01)
-/* \brief RSL Message Type (Chapter 9.1) */
+/* RSL Message Type (Chapter 9.1) */
enum abis_rsl_msgtype {
/* Radio Link Layer Management */
RSL_MT_DATA_REQ = 0x01,
@@ -182,7 +182,7 @@
RSL_MT_IPAC_DLCX_NACK,
};
-/*! \brief Siemens vendor-specific RSL message types */
+/*! Siemens vendor-specific RSL message types */
enum abis_rsl_msgtype_siemens {
RSL_MT_SIEMENS_MRPCI = 0x41,
RSL_MT_SIEMENS_INTRAC_HO_COND_IND = 0x42,
@@ -202,7 +202,7 @@
RSL_MT_SIEMENS_MODIF_COND_IND = 0x50,
};
-/*! \brief RSL Information Element Identifiers (Chapter 9.3) */
+/*! RSL Information Element Identifiers (Chapter 9.3) */
enum abis_rsl_ie {
RSL_IE_CHAN_NR = 0x01,
RSL_IE_LINK_IDENT,
@@ -340,7 +340,7 @@
#define RSL_ACT_SECOND_MULTI 0x05
#define RSL_ACT_OSMO_PDCH 0x0f /*< non-standard, for dyn TS */
-/*! \brief RSL Channel Mode IF (Chapter 9.3.6) */
+/*! RSL Channel Mode IF (Chapter 9.3.6) */
struct rsl_ie_chan_mode {
uint8_t dtx_dtu;
uint8_t spd_ind;
@@ -383,7 +383,7 @@
#define RSL_CMOD_CSD_T_600 0x14
#define RSL_CMOD_CSD_T_1200_75 0x15
-/*! \brief RSL Channel Identification IE (Chapter 9.3.5) */
+/*! RSL Channel Identification IE (Chapter 9.3.5) */
struct rsl_ie_chan_ident {
/* GSM 04.08 10.5.2.5 */
struct {
@@ -496,7 +496,7 @@
#define RSL_CHANNEED_TCH_F 0x02
#define RSL_CHANNEED_TCH_ForH 0x03
-/*! \brief RSL Cell Broadcast Command (Chapter 9.3.45) */
+/*! RSL Cell Broadcast Command (Chapter 9.3.45) */
struct rsl_ie_cb_cmd_type {
uint8_t last_block:2;
uint8_t spare:1;
@@ -603,7 +603,7 @@
RSL_REL_LOCAL_END = 1,
};
-/*! \brief ip.access specific embedded information elements */
+/*! ip.access specific embedded information elements */
enum rsl_ipac_embedded_ie {
RSL_IPAC_EIE_RXLEV = 0x00,
RSL_IPAC_EIE_RXQUAL = 0x01,
diff --git a/include/osmocom/gsm/protocol/gsm_12_21.h b/include/osmocom/gsm/protocol/gsm_12_21.h
index b35da44..1bdee9c 100644
--- a/include/osmocom/gsm/protocol/gsm_12_21.h
+++ b/include/osmocom/gsm/protocol/gsm_12_21.h
@@ -32,60 +32,60 @@
#include <stdbool.h>
#include <osmocom/gsm/tlv.h>
-/*! \brief generic header in front of every OML message according to TS 08.59 */
+/*! generic header in front of every OML message according to TS 08.59 */
struct abis_om_hdr {
- /*! \brief Message Discriminator \ref abis_oml_mdisc */
+ /*! Message Discriminator \ref abis_oml_mdisc */
uint8_t mdisc;
- /*! \brief Placement (like \ref ABIS_OM_PLACEMENT_ONLY) */
+ /*! Placement (like \ref ABIS_OM_PLACEMENT_ONLY) */
uint8_t placement;
- /*! \brief Sequence Number (if \ref ABIS_OM_PLACEMENT_MIDDLE) */
+ /*! Sequence Number (if \ref ABIS_OM_PLACEMENT_MIDDLE) */
uint8_t sequence;
- /*! \brief Length in octets */
+ /*! Length in octets */
uint8_t length;
- /*! \brief actual payload data */
+ /*! actual payload data */
uint8_t data[0];
} __attribute__ ((packed));
#define ABIS_NM_MSG_SIZE 1024
#define ABIS_NM_MSG_HEADROOM 128
-/*! \brief Message Discriminator for Formatted Object Messages */
+/*! Message Discriminator for Formatted Object Messages */
#define ABIS_OM_MDISC_FOM 0x80
-/*! \brief Message Discriminator for Man Machine Interface */
+/*! Message Discriminator for Man Machine Interface */
#define ABIS_OM_MDISC_MMI 0x40
-/*! \brief Message Discriminator for TRAU management */
+/*! Message Discriminator for TRAU management */
#define ABIS_OM_MDISC_TRAU 0x20
-/*! \brief Message Discriminator for Manufacturer Specific Messages */
+/*! Message Discriminator for Manufacturer Specific Messages */
#define ABIS_OM_MDISC_MANUF 0x10
-/*! \brief Entire OML message is in the L2 frame */
+/*! Entire OML message is in the L2 frame */
#define ABIS_OM_PLACEMENT_ONLY 0x80
-/*! \brief First fragment of OML message is in this L2 frame */
+/*! First fragment of OML message is in this L2 frame */
#define ABIS_OM_PLACEMENT_FIRST 0x40
-/*! \brief Middle fragment of OML message is in this L2 frame */
+/*! Middle fragment of OML message is in this L2 frame */
#define ABIS_OM_PLACEMENT_MIDDLE 0x20
-/*! \brief Last fragment of OML message is in this L2 frame */
+/*! Last fragment of OML message is in this L2 frame */
#define ABIS_OM_PLACEMENT_LAST 0x10
-/*! \brief OML Object Instance */
+/*! OML Object Instance */
struct abis_om_obj_inst {
- uint8_t bts_nr; /*!< \brief BTS Number */
- uint8_t trx_nr; /*!< \brief TRX Number */
- uint8_t ts_nr; /*!< \brief Timeslot Number */
+ uint8_t bts_nr; /*!< BTS Number */
+ uint8_t trx_nr; /*!< TRX Number */
+ uint8_t ts_nr; /*!< Timeslot Number */
} __attribute__ ((packed));
-/*! \brief OML Object Instance */
+/*! OML Object Instance */
struct abis_om_fom_hdr {
- uint8_t msg_type; /*!< \brief Message Type (\ref abis_nm_msgtype) */
- uint8_t obj_class; /*!< \brief Object Class (\ref abis_nm_obj_class) */
- struct abis_om_obj_inst obj_inst; /*!< \brief Object Instance */
- uint8_t data[0]; /*!< \brief Data */
+ uint8_t msg_type; /*!< Message Type (\ref abis_nm_msgtype) */
+ uint8_t obj_class; /*!< Object Class (\ref abis_nm_obj_class) */
+ struct abis_om_obj_inst obj_inst; /*!< Object Instance */
+ uint8_t data[0]; /*!< Data */
} __attribute__ ((packed));
-/*! \brief Size of the OML FOM header in octets */
+/*! Size of the OML FOM header in octets */
#define ABIS_OM_FOM_HDR_SIZE (sizeof(struct abis_om_hdr) + sizeof(struct abis_om_fom_hdr))
-/*! \brief OML Message Type (Section 9.1) */
+/*! OML Message Type (Section 9.1) */
enum abis_nm_msgtype {
/* SW Download Management Messages */
NM_MT_LOAD_INIT = 0x01,
@@ -196,7 +196,7 @@
NM_MT_SET_ALARM_THRES_NACK,
};
-/*! \brief Siemens specific OML Message Types */
+/*! Siemens specific OML Message Types */
enum abis_nm_msgtype_bs11 {
NM_MT_BS11_RESET_RESOURCE = 0x74,
@@ -232,7 +232,7 @@
NM_MT_BS11_RECONNECT_ACK,
};
-/*! \brief ip.access specific OML Message Types */
+/*! ip.access specific OML Message Types */
enum abis_nm_msgtype_ipacc {
NM_MT_IPACC_RESTART = 0x87,
NM_MT_IPACC_RESTART_ACK,
@@ -260,7 +260,7 @@
NM_MT_IPACC_SET_ATTR_NACK,
};
-/*! \brief OML Probable Cause (Section 9.4.43) Manufacturer specific values */
+/*! OML Probable Cause (Section 9.4.43) Manufacturer specific values */
enum abis_mm_event_causes {
/* Critical causes */
OSMO_EVT_CRIT_SW_FATAL = 0x0000,
@@ -288,7 +288,7 @@
NM_BS11_CANR_DCS1800 = 0x01,
};
-/*! \brief OML Object Class (Section 9.2) */
+/*! OML Object Class (Section 9.2) */
enum abis_nm_obj_class {
NM_OC_SITE_MANAGER = 0x00,
NM_OC_BTS,
@@ -319,7 +319,7 @@
NM_OC_NULL = 0xff,
};
-/*! \brief OML Attributes / IEs (Section 9.4) */
+/*! OML Attributes / IEs (Section 9.4) */
enum abis_nm_attr {
NM_ATT_ABIS_CHANNEL = 0x01,
NM_ATT_ADD_INFO,
@@ -519,7 +519,7 @@
};
#define NM_ATT_BS11_FILE_DATA NM_ATT_EVENT_TYPE
-/*! \brief OML Administrative State (Section 9.4.4) */
+/*! OML Administrative State (Section 9.4.4) */
enum abis_nm_adm_state {
NM_STATE_LOCKED = 0x01,
NM_STATE_UNLOCKED = 0x02,
@@ -527,7 +527,7 @@
NM_STATE_NULL = 0xff,
};
-/*! \brief OML Availability State (Section 9.4.7) */
+/*! OML Availability State (Section 9.4.7) */
enum abis_nm_avail_state {
NM_AVSTATE_IN_TEST = 1,
NM_AVSTATE_POWER_OFF = 2,
@@ -538,14 +538,14 @@
NM_AVSTATE_OK = 0xff,
};
-/*! \brief OML Operational State */
+/*! OML Operational State */
enum abis_nm_op_state {
NM_OPSTATE_DISABLED = 1,
NM_OPSTATE_ENABLED = 2,
NM_OPSTATE_NULL = 0xff,
};
-/* \brief Channel Combination (Section 9.4.13) */
+/* Channel Combination (Section 9.4.13) */
enum abis_nm_chan_comb {
NM_CHANC_TCHFull = 0x00, /* TCH/F + TCH/H + SACCH/TF */
NM_CHANC_TCHHalf = 0x01, /* TCH/H(0,1) + FACCH/H(0,1) +
@@ -570,7 +570,7 @@
NM_CHANC_OSMO_TCHFull_TCHHalf_PDCH = 0x90,
};
-/*! \brief Event Type (Section 9.4.16) */
+/*! Event Type (Section 9.4.16) */
enum abis_nm_event_type {
NM_EVT_COMM_FAIL = 0x00,
NM_EVT_QOS_FAIL = 0x01,
@@ -579,7 +579,7 @@
NM_EVT_ENV_FAIL = 0x04,
};
-/*! \brief Perceived Severity (Section: 9.4.63) */
+/*! Perceived Severity (Section: 9.4.63) */
enum abis_nm_severity {
NM_SEVER_CEASED = 0x00,
NM_SEVER_CRITICAL = 0x01,
@@ -589,7 +589,7 @@
NM_SEVER_INDETERMINATE = 0x05,
};
-/*! \brief Probable Cause Type (Section 9.4.43) */
+/*! Probable Cause Type (Section 9.4.43) */
enum abis_nm_pcause_type {
NM_PCAUSE_T_X721 = 0x01,
NM_PCAUSE_T_GSM = 0x02,
@@ -600,7 +600,7 @@
extern const struct value_string abis_nm_msgtype_names[];
extern const struct value_string abis_nm_att_names[];
-/*! \brief NACK causes (Section 9.4.36) */
+/*! NACK causes (Section 9.4.36) */
enum abis_nm_nack_cause {
/* General Nack Causes */
NM_NACK_INCORR_STRUCT = 0x01,
@@ -638,15 +638,15 @@
NM_NACK_MEAS_NOTSTART = 0x2c,
};
-/*! \brief Abis OML Channel (Section 9.4.1) */
+/*! Abis OML Channel (Section 9.4.1) */
struct abis_nm_channel {
uint8_t attrib;
- uint8_t bts_port; /*!< \brief BTS port number */
- uint8_t timeslot; /*!< \brief E1 timeslot */
- uint8_t subslot; /*!< \brief E1 sub-slot */
+ uint8_t bts_port; /*!< BTS port number */
+ uint8_t timeslot; /*!< E1 timeslot */
+ uint8_t subslot; /*!< E1 sub-slot */
} __attribute__ ((packed));
-/*! \brief 3GPP TS 12.21 9.4.53 T200 index */
+/*! 3GPP TS 12.21 9.4.53 T200 index */
enum abis_nm_t200_idx {
T200_SDCCH = 0,
T200_FACCH_F = 1,
@@ -659,7 +659,7 @@
extern const uint8_t abis_nm_t200_ms[];
-/*! \brief Siemens BS-11 specific objects in the SienemsHW (0xA5) object class */
+/*! Siemens BS-11 specific objects in the SienemsHW (0xA5) object class */
enum abis_bs11_objtype {
BS11_OBJ_ALCO = 0x01,
BS11_OBJ_BBSIG = 0x02, /* obj_class: 0,1 */
@@ -670,7 +670,7 @@
BS11_OBJ_PA = 0x09, /* obj_class: 0, 1*/
};
-/*! \brief Siemens BS11 TRX power */
+/*! Siemens BS11 TRX power */
enum abis_bs11_trx_power {
BS11_TRX_POWER_GSM_2W = 0x06,
BS11_TRX_POWER_GSM_250mW= 0x07,
@@ -682,20 +682,20 @@
BS11_TRX_POWER_DCS_160mW= 0x0d,
};
-/*! \brief Siemens BS11 PLL mode */
+/*! Siemens BS11 PLL mode */
enum abis_bs11_li_pll_mode {
BS11_LI_PLL_LOCKED = 2,
BS11_LI_PLL_STANDALONE = 3,
};
-/*! \brief Siemens BS11 E1 line configuration */
+/*! Siemens BS11 E1 line configuration */
enum abis_bs11_line_cfg {
BS11_LINE_CFG_STAR = 0x00,
BS11_LINE_CFG_MULTIDROP = 0x01,
BS11_LINE_CFG_LOOP = 0x02,
};
-/*! \brief Siemens BS11 boot phase */
+/*! Siemens BS11 boot phase */
enum abis_bs11_phase {
BS11_STATE_SOFTWARE_RQD = 0x01,
BS11_STATE_LOAD_SMU_INTENDED = 0x11,
@@ -712,7 +712,7 @@
BS11_STATE_ABIS_LOAD = 0x13,
};
-/*! \brief ip.access test number */
+/*! ip.access test number */
enum abis_nm_ipacc_test_no {
NM_IPACC_TESTNO_RLOOP_ANT = 0x01,
NM_IPACC_TESTNO_RLOOP_XCVR = 0x02,
@@ -726,7 +726,7 @@
NM_IPACC_TESTNO_BCCCH_MONITOR = 0x46,
};
-/*! \brief first byte after length inside NM_ATT_TEST_REPORT */
+/*! first byte after length inside NM_ATT_TEST_REPORT */
enum abis_nm_ipacc_test_res {
NM_IPACC_TESTRES_SUCCESS = 0,
NM_IPACC_TESTRES_TIMEOUT = 1,
@@ -735,7 +735,7 @@
NM_IPACC_TESTRES_STOPPED = 4,
};
-/*! \brief internal IE inside NM_ATT_TEST_REPORT */
+/*! internal IE inside NM_ATT_TEST_REPORT */
enum abis_nm_ipacc_testres_ie {
NM_IPACC_TR_IE_FREQ_ERR_LIST = 3,
NM_IPACC_TR_IE_CHAN_USAGE = 4,
@@ -744,7 +744,7 @@
NM_IPACC_TR_IE_FREQ_ERR = 18,
};
-/*! \brief ip.access IEI */
+/*! ip.access IEI */
enum ipac_eie {
NM_IPAC_EIE_ARFCN_WHITE = 0x01,
NM_IPAC_EIE_ARFCH_BLACK = 0x02,
@@ -777,7 +777,7 @@
NM_IPAC_EIE_BTS_ID = 0x25,
};
-/*! \brief ip.access NWL BCCH information type */
+/*! ip.access NWL BCCH information type */
enum ipac_bcch_info_type {
IPAC_BINF_RXLEV = (1 << 8),
IPAC_BINF_RXQUAL = (1 << 9),
@@ -792,7 +792,7 @@
IPAC_BINF_CELL_ALLOC = (1 << 2),
};
-/*! \brief 3GPP TS 52.021 §9.4.62 SW Description */
+/*! 3GPP TS 52.021 §9.4.62 SW Description */
struct abis_nm_sw_desc {
uint8_t file_id[UINT8_MAX];
uint8_t file_id_len;