Skip to content

Commit 9e2b516

Browse files
committed
Fix doxygen for MbedCRC
1 parent 9974899 commit 9e2b516

File tree

2 files changed

+10
-11
lines changed

2 files changed

+10
-11
lines changed

drivers/MbedCRC.h

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,11 @@ namespace mbed {
4343
/** \addtogroup drivers */
4444
/** @{*/
4545

46+
extern SingletonPtr<PlatformMutex> mbed_crc_mutex;
47+
4648
/** CRC object provides CRC generation through hardware/software
4749
*
48-
* ROM polynomial tables for supported polynomials (:: crc_polynomial_t) will be used for
50+
* ROM polynomial tables for supported polynomials (::crc_polynomial) will be used for
4951
* software CRC computation, if ROM tables are not available then CRC is computed runtime
5052
* bit by bit for all data input.
5153
* @note Synchronization level: Thread safe
@@ -93,9 +95,6 @@ namespace mbed {
9395
* @endcode
9496
* @ingroup drivers
9597
*/
96-
97-
extern SingletonPtr<PlatformMutex> mbed_crc_mutex;
98-
9998
template <uint32_t polynomial = POLY_32BIT_ANSI, uint8_t width = 32>
10099
class MbedCRC {
101100

hal/crc_api.h

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,13 @@
2828
* Different polynomial values supported
2929
*/
3030
typedef enum crc_polynomial {
31-
POLY_OTHER = 0,
32-
POLY_8BIT_CCITT = 0x07, // x8+x2+x+1
33-
POLY_7BIT_SD = 0x9, // x7+x3+1;
34-
POLY_16BIT_CCITT = 0x1021, // x16+x12+x5+1
35-
POLY_16BIT_IBM = 0x8005, // x16+x15+x2+1
36-
POLY_32BIT_ANSI = 0x04C11DB7, // x32+x26+x23+x22+x16+x12+x11+x10+x8+x7+x5+x4+x2+x+1
37-
POLY_32BIT_REV_ANSI = 0xEDB88320
31+
POLY_OTHER = 0, ///< Custom polynomial
32+
POLY_8BIT_CCITT = 0x07, ///< x8+x2+x+1
33+
POLY_7BIT_SD = 0x9, ///< x7+x3+1
34+
POLY_16BIT_CCITT = 0x1021, ///< x16+x12+x5+1
35+
POLY_16BIT_IBM = 0x8005, ///< x16+x15+x2+1
36+
POLY_32BIT_ANSI = 0x04C11DB7, ///< x32+x26+x23+x22+x16+x12+x11+x10+x8+x7+x5+x4+x2+x+1
37+
POLY_32BIT_REV_ANSI = 0xEDB88320 ///< x31+x30+x29+x27+x26+x24+x23+x21+x20+x19+x15+x9+x8+x5
3838
} crc_polynomial_t;
3939

4040
typedef struct crc_mbed_config {

0 commit comments

Comments
 (0)