diff options
| author | Harald Welte <laforge@gnumonks.org> | 2016-04-25 12:11:20 +0200 |
|---|---|---|
| committer | Harald Welte <laforge@gnumonks.org> | 2016-05-05 18:49:27 +0200 |
| commit | 2d2e2cca0dc1d62addc9c9fcb3a59f343fc3baf6 (patch) | |
| tree | 8ec3ba89d486e4c324d32d1980ce68d5118d2db1 /src/crc16.c | |
| parent | 0996c879255e4653740814112bf98d0ddc93100c (diff) | |
Update doxygen annotations in libosmocore
This adds and improves doxygen API descriptions all over libosmocore,
reducing the 'white spots' that don't have any documentation.
Diffstat (limited to 'src/crc16.c')
| -rw-r--r-- | src/crc16.c | 14 |
1 files changed, 6 insertions, 8 deletions
diff --git a/src/crc16.c b/src/crc16.c index 2741cf53..9dd46727 100644 --- a/src/crc16.c +++ b/src/crc16.c @@ -10,7 +10,7 @@ #include <osmocom/core/crc16.h> -/** CRC table for the CRC-16. The poly is 0x8005 (x^16 + x^15 + x^2 + 1) */ +/*! \brief CRC table for the CRC-16. The poly is 0x8005 (x^16 + x^15 + x^2 + 1) */ uint16_t const osmo_crc16_table[256] = { 0x0000, 0xC0C1, 0xC181, 0x0140, 0xC301, 0x03C0, 0x0280, 0xC241, 0xC601, 0x06C0, 0x0780, 0xC741, 0x0500, 0xC5C1, 0xC481, 0x0440, @@ -46,13 +46,11 @@ uint16_t const osmo_crc16_table[256] = { 0x8201, 0x42C0, 0x4380, 0x8341, 0x4100, 0x81C1, 0x8081, 0x4040 }; -/** - * crc16 - compute the CRC-16 for the data buffer - * @crc: previous CRC value - * @buffer: data pointer - * @len: number of bytes in the buffer - * - * Returns the updated CRC value. +/*! \brief compute the CRC-16 for the data buffer + * \param crc[in] previous CRC value + * \param buffer[in] data pointer + * \param len[in] number of bytes in input \ref buffer + * \return updated CRC value */ uint16_t osmo_crc16(uint16_t crc, uint8_t const *buffer, size_t len) { |