Change in libosmocore[master]: coding: fix documentation of PDTCH encoding functions

[laforge]

laforge has submitted this change. ( https://gerrit.osmocom.org/c/libosmocore/+/17672 )

Change subject: coding: fix documentation of PDTCH encoding functions
......................................................................

coding: fix documentation of PDTCH encoding functions

Change-Id: Ia38723fb9424551eaf5747d736ae73ab20873def
---
M src/coding/gsm0503_coding.c
1 file changed, 2 insertions(+), 2 deletions(-)

Approvals:
  Jenkins Builder: Verified
  laforge: Looks good to me, approved
  pespin: Looks good to me, but someone else must approve



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];

-- 
To view, visit https://gerrit.osmocom.org/c/libosmocore/+/17672
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings

Gerrit-Project: libosmocore
Gerrit-Branch: master
Gerrit-Change-Id: Ia38723fb9424551eaf5747d736ae73ab20873def
Gerrit-Change-Number: 17672
Gerrit-PatchSet: 4
Gerrit-Owner: fixeria <axilirator at gmail.com>
Gerrit-Reviewer: Jenkins Builder
Gerrit-Reviewer: fixeria <axilirator at gmail.com>
Gerrit-Reviewer: laforge <laforge at osmocom.org>
Gerrit-Reviewer: pespin <pespin at sysmocom.de>
Gerrit-MessageType: merged
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osmocom.org/pipermail/gerrit-log/attachments/20200401/319e4b92/attachment.htm>