From 83dac36eda7909ac0a294b400ca317565865f410 Mon Sep 17 00:00:00 2001 From: Guillaume Souchere Date: Thu, 25 Aug 2022 11:57:43 +0200 Subject: [PATCH] Add missing doxygen comments on the tlsf_check_hook() declaration --- tlsf.h | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/tlsf.h b/tlsf.h index a36017f..3dcdb1e 100644 --- a/tlsf.h +++ b/tlsf.h @@ -64,7 +64,18 @@ int tlsf_check_pool(pool_t pool); */ __attribute__((weak)) void block_absorb_post_hook(void *start, size_t size, bool is_free); -__attribute__((weak)) bool tlsf_check_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) };