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