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

Change subject: gsm23003: fix docstring for osmo_plmn_from_bcd() ......................................................................

gsm23003: fix docstring for osmo_plmn_from_bcd()

The parameters described in the docstrings for osmo_plmn_from_bcd() do not match the actual parameter list.

Change-Id: Ic0999dbe096a98418db7482bd110e20497d8e4a5 --- M src/gsm/gsm23003.c 1 file changed, 5 insertions(+), 7 deletions(-)

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

diff --git a/src/gsm/gsm23003.c b/src/gsm/gsm23003.c index 71d44fb..b893873 100644 --- a/src/gsm/gsm23003.c +++ b/src/gsm/gsm23003.c @@ -445,14 +445,12 @@ } }

-/* Convert given 3-byte BCD buffer to integers and write results to *mcc and - * *mnc. The first three BCD digits result in the MCC and the remaining ones in - * the MNC. Return mnc_3_digits as false if the MNC's most significant digit is encoded as 0xF, true - * otherwise; i.e. true if MNC > 99 or if it is represented with leading zeros instead of 0xF. +/* Convert given 3-byte BCD buffer to integers and write results to plmn->mcc and plmn->mnc. The first three BCD digits + * result in the MCC and the remaining ones in the MNC. Set plmn->mnc_3_digits as false if the MNC's most significant + * digit is encoded as 0xF, true otherwise; i.e. true if MNC > 99 or if it is represented with leading zeros instead of + * 0xF. * \param[in] bcd_src 3-byte BCD buffer containing MCC+MNC representations. - * \param[out] mcc MCC result buffer, or NULL. - * \param[out] mnc MNC result buffer, or NULL. - * \param[out] mnc_3_digits Result buffer for 3-digit flag, or NULL. + * \param[out] plmn user provided memory to store the result. */ void osmo_plmn_from_bcd(const uint8_t *bcd_src, struct osmo_plmn_id *plmn) {