Change in libosmocore[master]: libosmogsm: add Doxygen docs for gsm0502_hop_seq_gen()

[fixeria]

Hello laforge,

I'd like you to do a code review. Please visit

    https://gerrit.osmocom.org/c/libosmocore/+/18245

to review the following change.


Change subject: libosmogsm: add Doxygen docs for gsm0502_hop_seq_gen()
......................................................................

libosmogsm: add Doxygen docs for gsm0502_hop_seq_gen()

Change-Id: Ife660f00d7a6d3b874ab2e59e34dca2109fa82d8
Related: OS#4546
---
M src/gsm/gsm0502.c
1 file changed, 9 insertions(+), 1 deletion(-)



  git pull ssh://gerrit.osmocom.org:29418/libosmocore refs/changes/45/18245/1

diff --git a/src/gsm/gsm0502.c b/src/gsm/gsm0502.c
index 7e8dc92..025912f 100644
--- a/src/gsm/gsm0502.c
+++ b/src/gsm/gsm0502.c
@@ -219,7 +219,15 @@
 	125,  99,  17, 123,
 };
 
-/*! Hopping sequence generation as per 3GPP TS 45.002, section 6.2.3. */
+/*! Hopping sequence generation as per 3GPP TS 45.002, section 6.2.3.
+ *  \param[in] t GSM time (TDMA frame number, T1/T2/T3).
+ *  \param[in] hsn Hopping Sequence Number.
+ *  \param[in] maio Mobile Allocation Index Offset.
+ *  \param[in] n number of entries in mobile allocation (arfcn table).
+ *  \param[in] ma array of ARFCN representing the Mobile Allocation.
+ *  \returns ARFCN to use for given input parameters at time 't'
+ *	     or Mobile Allocation Index if ma == NULL.
+ */
 uint16_t gsm0502_hop_seq_gen(const struct gsm_time *t,
 			     uint8_t hsn, uint8_t maio,
 			     size_t n, const uint16_t *ma)

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

Gerrit-Project: libosmocore
Gerrit-Branch: master
Gerrit-Change-Id: Ife660f00d7a6d3b874ab2e59e34dca2109fa82d8
Gerrit-Change-Number: 18245
Gerrit-PatchSet: 1
Gerrit-Owner: fixeria <axilirator at gmail.com>
Gerrit-Reviewer: laforge <laforge at osmocom.org>
Gerrit-MessageType: newchange
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osmocom.org/pipermail/gerrit-log/attachments/20200513/bb02e1d7/attachment.htm>