Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix #1485, Document CFE_ES_PoolCreateEx NumBlockSizes error handling #1562

Merged
merged 1 commit into from
May 27, 2021
Merged

Fix #1485, Document CFE_ES_PoolCreateEx NumBlockSizes error handling #1562

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions modules/core_api/fsw/inc/cfe_es.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1254,8 +1254,10 @@ CFE_Status_t CFE_ES_PoolCreate(CFE_ES_MemHandle_t *PoolID, void *MemPtr, size_t
** \param[in] Size The size of the pool of memory. Note that this must be an integral multiple of the
** memory alignment of the processor architecture.
**
** \param[in] NumBlockSizes The number of different block sizes specified in the \c BlockSizes array. If set equal to
** zero or if greater than 17, then default block sizes are used.
** \param[in] NumBlockSizes The number of different block sizes specified in the \c BlockSizes array. If set
** larger than #CFE_PLATFORM_ES_POOL_MAX_BUCKETS, #CFE_ES_BAD_ARGUMENT will be returned.
** If BlockSizes is null and NumBlockSizes is 0, NubBlockSizes will be set to
** #CFE_PLATFORM_ES_POOL_MAX_BUCKETS.
**
** \param[in] BlockSizes Pointer to an array of sizes to be used instead of the default block sizes specified by
** #CFE_PLATFORM_ES_MEM_BLOCK_SIZE_01 through #CFE_PLATFORM_ES_MAX_BLOCK_SIZE. If the
Expand Down