Imagelibrary/tlsf
1
0
Fork 0
mirror of https://github.com/espressif/tlsf.git synced 2025-12-05 15:15:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add missing doxygen comments on the tlsf_check_hook() declaration

Browse Source
This commit is contained in:
Guillaume Souchere
2022-08-25 11:57:43 +02:00
parent f71c4077d4
commit 83dac36eda
1 changed files with 12 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
tlsf.h
View File

@@ -64,6 +64,17 @@ int tlsf_check_pool(pool_t pool);
*/
__attribute__((weak)) void block_absorb_post_hook(void *start, size_t size, bool is_free);
/**
* @brief Weak function called on every free block of memory allowing the user to implement
* application specific checks on the memory.
*
* @param start The start pointer to the memory of a block
* @param size The size of the memory in the block
* @param is_free Set to true when the memory belongs to a free block.
* False if it belongs to an allocated block.
* @return true The checks found no inconsistency in the memory
* @return false The checks in the function highlighted an inconsistency in the memory
*/
__attribute__((weak)) bool tlsf_check_hook(void *start, size_t size, bool is_free);
#if defined(__cplusplus)