mirror of
https://github.com/OpenTTD/OpenTTD.git
synced 2026-07-15 15:19:52 +00:00
Codefix: expand some macros, so doxygen actually sees what is documented
This commit is contained in:
+1
-1
@@ -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
|
||||
|
||||
@@ -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<Tindex>)::AllocateItem(size_t size, size_t index)
|
||||
{
|
||||
@@ -107,7 +108,7 @@ DEFINE_POOL_METHOD(inline AllocationResult<Tindex>)::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<Tindex>)::GetNew(size_t size)
|
||||
@@ -130,7 +131,7 @@ DEFINE_POOL_METHOD(AllocationResult<Tindex>)::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<Tindex>)::GetNew(size_t size, size_t index)
|
||||
|
||||
Reference in New Issue
Block a user