falconia has uploaded this change for review. ( https://gerrit.osmocom.org/c/libosmo-abis/+/39667?usp=email )
Change subject: trau_frame cosmetic: fix doxygen comments ......................................................................
trau_frame cosmetic: fix doxygen comments
Change-Id: I5a69c25c4abeef0b62d92bedc2c56a2d533390c5 --- M src/trau/trau_frame.c 1 file changed, 4 insertions(+), 4 deletions(-)
git pull ssh://gerrit.osmocom.org:29418/libosmo-abis refs/changes/67/39667/1
diff --git a/src/trau/trau_frame.c b/src/trau/trau_frame.c index 74f4526..b8085c2 100644 --- a/src/trau/trau_frame.c +++ b/src/trau/trau_frame.c @@ -1231,10 +1231,10 @@
/*! Encode a TRAU frame from its decoded representation to a sequence of unpacked bits. - * \param[out] bits caller-allocated buffer for unpacked outpud bits + * \param[out] bits caller-allocated buffer for unpacked output bits * \param[in] n_bits size of 'bits' output buffer in number of unpacked bits * \param[in] fr decoded representation of TRAU frame to be encoded - * \return 0 number of unpacked output bits generated; negative in case of error + * \returns number of unpacked output bits generated; negative in case of error * * This function exhibits a behavioral quirk which users need to be aware of: * for many frame types, the first 5 bits out of user-provided fr->c_bits[] @@ -1326,10 +1326,10 @@ }
/*! Encode a TFO frame from its decoded representation to a sequence of unpacked bits. - * \param[out] bits caller-allocated buffer for unpacked outpud bits + * \param[out] bits caller-allocated buffer for unpacked output bits * \param[in] n_bits size of 'bits' output buffer in number of unpacked bits * \param[in] fr decoded representation of TRAU frame to be encoded - * \return 0 number of unpacked output bits generated; negative in case of error + * \returns number of unpacked output bits generated; negative in case of error * * Compared to regular osmo_trau_frame_encode(), this TFO-specific TRAU frame * encoding function restricts the set of possible frame types to those that