Skip to content
Commit 2a5051f3 authored by Carles Cufi's avatar Carles Cufi Committed by Anas Nashif
Browse files

include: sys: crc: Clarify documentation of two crc functions



The crc16_ccitt and crc16_itu_t functions' documentation could lead to
slight misunderstandings because of the fact that, although they bear
those names, those functions are actually able to compute CRCs that bear
other names, depending on the inital seed provided and an optional XOR
on the result.
In order to avoid confusion, document thoroughly with links to the
standard reveng page that lists all existing CRCs.

Signed-off-by: default avatarCarles Cufi <carles.cufi@nordicsemi.no>
parent 8e3f1615
Loading
Loading
Loading
Loading
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please to comment