diff options
| author | Neels Hofmeyr <nhofmeyr@sysmocom.de> | 2017-06-20 00:17:59 +0200 |
|---|---|---|
| committer | Neels Hofmeyr <nhofmeyr@sysmocom.de> | 2017-06-23 00:18:22 +0000 |
| commit | 87e4550585c643e97e0003119b254251ac5ed1d4 (patch) | |
| tree | 9287f66aba70e9253f4d62926c54dddeb492895e /src/gsm/sysinfo.c | |
| parent | 249fb71a2e124acb191b7cd4d2c3af6a45da4a5e (diff) | |
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
Diffstat (limited to 'src/gsm/sysinfo.c')
| -rw-r--r-- | src/gsm/sysinfo.c | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/src/gsm/sysinfo.c b/src/gsm/sysinfo.c index b5ebd57d..201acfc8 100644 --- a/src/gsm/sysinfo.c +++ b/src/gsm/sysinfo.c @@ -125,7 +125,7 @@ const struct value_string osmo_sitype_strs[_MAX_SYSINFO_TYPE] = { { 0, NULL } }; -/*! \brief Add pair of arfcn and measurement bandwith value to earfcn struct +/*! Add pair of arfcn and measurement bandwith value to earfcn struct * \param[in,out] e earfcn struct * \param[in] arfcn EARFCN value, 16 bits * \param[in] meas_bw measurement bandwith value @@ -144,7 +144,7 @@ int osmo_earfcn_add(struct osmo_earfcn_si2q *e, uint16_t arfcn, uint8_t meas_bw) return -ENOMEM; } -/*! \brief Return number of bits necessary to represent earfcn struct as +/*! Return number of bits necessary to represent earfcn struct as * Repeated E-UTRAN Neighbour Cells IE from 3GPP TS 44.018 Table 10.5.2.33b.1 * \param[in,out] e earfcn struct * \returns number of bits @@ -154,7 +154,7 @@ size_t osmo_earfcn_bit_size(const struct osmo_earfcn_si2q *e) return osmo_earfcn_bit_size_ext(e, 0); } -/*! \brief Return number of bits necessary to represent earfcn struct as +/*! Return number of bits necessary to represent earfcn struct as * Repeated E-UTRAN Neighbour Cells IE from 3GPP TS 44.018 Table 10.5.2.33b.1 * \param[in,out] e earfcn struct * \param[in] offset into earfcn struct: how many EARFCNs to skip while estimating size @@ -183,7 +183,7 @@ size_t osmo_earfcn_bit_size_ext(const struct osmo_earfcn_si2q *e, size_t offset) return bits; } -/*! \brief Delete arfcn (and corresponding measurement bandwith) from earfcn +/*! Delete arfcn (and corresponding measurement bandwith) from earfcn * struct * \param[in,out] e earfcn struct * \param[in] arfcn EARFCN value, 16 bits @@ -202,7 +202,7 @@ int osmo_earfcn_del(struct osmo_earfcn_si2q *e, uint16_t arfcn) return -ENOENT; } -/*! \brief Initialize earfcn struct +/*! Initialize earfcn struct * \param[in,out] e earfcn struct */ void osmo_earfcn_init(struct osmo_earfcn_si2q *e) |