From 78fb3b404470aad46bf61c4d457b729ca6f00bbf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=D0=91=D1=80=D0=B0=D0=BD=D0=B8=D0=BC=D0=B8=D1=80=20=D0=9A?= =?UTF-8?q?=D0=B0=D1=80=D0=B0=D1=9F=D0=B8=D1=9B?= Date: Thu, 18 Aug 2022 18:11:54 -0700 Subject: [PATCH] Updated AllocatorI::realloc docs. --- include/bx/allocator.h | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/include/bx/allocator.h b/include/bx/allocator.h index 565dd32..aa0757e 100644 --- a/include/bx/allocator.h +++ b/include/bx/allocator.h @@ -47,13 +47,20 @@ namespace bx /// virtual ~AllocatorI() = 0; - /// Allocates, resizes memory block, or frees memory. + /// Allocates, resizes, or frees memory block. /// - /// @param[in] _ptr If _ptr is NULL new block will be allocated. + /// @remark + /// - Allocate memory block: _ptr == NULL && size > 0 + /// - Resize memory block: _ptr != NULL && size > 0 + /// - Free memory block: _ptr != NULL && size == 0 + /// + /// @param[in] _ptr If _ptr is NULL new block will be allocated. If _ptr is not-NULL, and + /// _size is not 0, memory block will be resized. /// @param[in] _size If _ptr is set, and _size is 0, memory will be freed. /// @param[in] _align Alignment. /// @param[in] _file Debug file path info. /// @param[in] _line Debug file line info. + /// virtual void* realloc( void* _ptr , size_t _size