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/codec | |
| 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/codec')
| -rw-r--r-- | src/codec/gsm610.c | 2 | ||||
| -rw-r--r-- | src/codec/gsm620.c | 2 | ||||
| -rw-r--r-- | src/codec/gsm690.c | 4 |
3 files changed, 4 insertions, 4 deletions
diff --git a/src/codec/gsm610.c b/src/codec/gsm610.c index c1eca0c3..df56583a 100644 --- a/src/codec/gsm610.c +++ b/src/codec/gsm610.c @@ -298,7 +298,7 @@ const uint16_t gsm610_bitorder[260] = { 29, /* LARc5:0 */ }; -/*! \brief Check whether RTP frame contains FR SID code word according to +/*! Check whether RTP frame contains FR SID code word according to * TS 101 318 §5.1.2 * \param[in] rtp_payload Buffer with RTP payload * \param[in] payload_len Length of payload diff --git a/src/codec/gsm620.c b/src/codec/gsm620.c index 7067239c..30647480 100644 --- a/src/codec/gsm620.c +++ b/src/codec/gsm620.c @@ -272,7 +272,7 @@ static inline uint16_t mask(const uint8_t msb) return (m - 1) ^ m; } -/*! \brief Check whether RTP frame contains HR SID code word according to +/*! Check whether RTP frame contains HR SID code word according to * TS 101 318 §5.2.2 * \param[in] rtp_payload Buffer with RTP payload * \param[in] payload_len Length of payload diff --git a/src/codec/gsm690.c b/src/codec/gsm690.c index b273f0fe..74655bf4 100644 --- a/src/codec/gsm690.c +++ b/src/codec/gsm690.c @@ -235,7 +235,7 @@ const struct value_string osmo_amr_type_names[] = { { 0, NULL }, }; -/*! \brief Decode various AMR parameters from RTP payload (RFC 4867) acording to +/*! Decode various AMR parameters from RTP payload (RFC 4867) acording to * 3GPP TS 26.101 * \param[in] rtppayload Payload from RTP packet * \param[in] payload_len length of rtppayload @@ -284,7 +284,7 @@ int osmo_amr_rtp_dec(const uint8_t *rtppayload, int payload_len, uint8_t *cmr, return 2 + amr_len_by_ft[type]; } -/*! \brief Encode various AMR parameters from RTP payload (RFC 4867) +/*! Encode various AMR parameters from RTP payload (RFC 4867) * \param[out] payload Payload for RTP packet, contains speech data (if any) * except for have 2 first bytes where header will be built * \param[in] cmr AMR codec Mode Request |