commit 8055cddbe270fdcab5d0e8abdcaedb5ae47ada1b
author Vadim Yanitskiy <axilirator@gmail.com> Mon Mar 30 18:16:38 2020 +0700
committer Vadim Yanitskiy <axilirator@gmail.com> Tue Mar 31 15:37:27 2020 +0700
tree f030498dea4050c92f6335d38b815006cb3501d9
parent 88c61c382238a4dc382e9c6744d1eb0693e90fc1

coding: fix documentation of PDTCH encoding functions

Change-Id: Ia38723fb9424551eaf5747d736ae73ab20873def

src/coding/gsm0503_coding.c

diff --git a/src/coding/gsm0503_coding.c b/src/coding/gsm0503_coding.c
index 7385d23..163ce21 100644
--- a/src/coding/gsm0503_coding.c
+++ b/src/coding/gsm0503_coding.c
@@ -1332,7 +1332,7 @@
  *  \param[out] bursts caller-allocated buffer for unpacked burst bits
  *  \param[in] l2_data L2 (MAC) block to be encoded
  *  \param[in] l2_len length of l2_data in bytes, used to determine MCS
- *  \returns 0 on success; negative on error */
+ *  \returns number of bits encoded; negative on error */
 int gsm0503_pdtch_egprs_encode(ubit_t *bursts,
 	const uint8_t *l2_data, uint8_t l2_len)
 {
@@ -1427,7 +1427,7 @@
  *  \param[out] bursts caller-allocated buffer for unpacked burst bits
  *  \param[in] l2_data L2 (MAC) block to be encoded
  *  \param[in] l2_len length of l2_data in bytes, used to determine CS
- *  \returns 0 on success; negative on error */
+ *  \returns number of bits encoded; negative on error */
 int gsm0503_pdtch_encode(ubit_t *bursts, const uint8_t *l2_data, uint8_t l2_len)
 {
 	ubit_t iB[456], cB[676];