From ae7af6c4631ce0e3487bb0f5594edec6d3e87668 Mon Sep 17 00:00:00 2001 From: Rubidium Date: Sun, 1 Feb 2026 09:28:29 +0100 Subject: [PATCH] Codefix: expand some macros, so doxygen actually sees what is documented --- Doxyfile.in | 2 +- src/core/pool_func.hpp | 5 +++-- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/Doxyfile.in b/Doxyfile.in index e68d79e99e..b4dd507e82 100644 --- a/Doxyfile.in +++ b/Doxyfile.in @@ -324,7 +324,7 @@ PREDEFINED = WITH_ZLIB \ _UNICODE \ _GNU_SOURCE \ FINAL= -EXPAND_AS_DEFINED = +EXPAND_AS_DEFINED = DEFINE_POOL_METHOD SKIP_FUNCTION_MACROS = YES #--------------------------------------------------------------------------- # Configuration options related to external references diff --git a/src/core/pool_func.hpp b/src/core/pool_func.hpp index 8140dde4ef..1e80c7cf08 100644 --- a/src/core/pool_func.hpp +++ b/src/core/pool_func.hpp @@ -82,6 +82,7 @@ DEFINE_POOL_METHOD(inline size_t)::FindFirstFree() * @param index index of item * @pre index < this->size * @pre this->Get(index) == nullptr + * @return The resulting allocation and pool-type index. */ DEFINE_POOL_METHOD(inline AllocationResult)::AllocateItem(size_t size, size_t index) { @@ -107,7 +108,7 @@ DEFINE_POOL_METHOD(inline AllocationResult)::AllocateItem(size_t size, s /** * Allocates new item * @param size size of item - * @return pointer to allocated item and the index of said item. + * @return The resulting allocation and pool-type index. * @note FatalError() on failure! (no free item) */ DEFINE_POOL_METHOD(AllocationResult)::GetNew(size_t size) @@ -130,7 +131,7 @@ DEFINE_POOL_METHOD(AllocationResult)::GetNew(size_t size) * Allocates new item with given index * @param size size of item * @param index index of item - * @return pointer to allocated item + * @return The resulting allocation and pool-type index. * @note SlErrorCorruptFmt() on failure! (index out of range or already used) */ DEFINE_POOL_METHOD(AllocationResult)::GetNew(size_t size, size_t index)