[PATCH 2/3] Add left circular shift function

Sylvain Munaut 246tnt at gmail.com
Tue Mar 18 06:37:30 UTC 2014


> +/*! \brief left circular shift
> + *  \param[in] in The 16 bit unsigned integer to be rotated
> + *  \param[in] shift Number of bits to shift \a in to
> + */

Missing the \returns

And yes, I know it's sometimes trivial but when processed by Doxygen
you have everything nicely hyperlinked if you filled everything out.

While you're at it, you could add the valid range to 'shift' doc
(seems to be 0 to 16 included). Could seem obvious but at least it
removes any doubt (that for example using negative would do a ror ...
or that it would handle multiple complete rotation).

Also please _wait_ until the next re-spin. I haven't looked at the
third patch yet and haven't tried to actually _run_ them. I'm just
sending this feedback know so that you know I'm looking at it, but
since I've been away for 2 weeks, I have a bunch of stuff to catch up



More information about the baseband-devel mailing list