mirror of
https://github.com/RIOT-OS/RIOT.git
synced 2024-12-29 04:50:03 +01:00
core/cib: fix documented maximum size restrictions
MAXINT is not a defined value and since the types are unsigned also misleading.
This commit is contained in:
parent
fcd36f7b77
commit
c2e1b8afea
@ -39,6 +39,10 @@ typedef struct {
|
||||
|
||||
/**
|
||||
* @brief Initialize cib_t to a given size.
|
||||
*
|
||||
* @param[in] SIZE Size of the buffer, must not exceed
|
||||
* (`UINT_MAX` + 1) / 2.
|
||||
* Should be equal to 0 or power of 2.
|
||||
*/
|
||||
#define CIB_INIT(SIZE) { 0, 0, (SIZE)-1 }
|
||||
|
||||
@ -47,7 +51,8 @@ typedef struct {
|
||||
*
|
||||
* @param[out] cib Buffer to initialize.
|
||||
* Must not be NULL.
|
||||
* @param[in] size Size of the buffer, must not exceed MAXINT/2.
|
||||
* @param[in] size Size of the buffer, must not exceed
|
||||
* (`UINT_MAX` + 1) / 2.
|
||||
* Should be equal to 0 or power of 2.
|
||||
*/
|
||||
static inline void cib_init(cib_t *__restrict cib, unsigned int size)
|
||||
|
Loading…
Reference in New Issue
Block a user