Browse Source

Updated AllocatorI::realloc docs.

Бранимир Караџић 3 years ago
parent
commit
78fb3b4044
1 changed files with 9 additions and 2 deletions
  1. 9 2
      include/bx/allocator.h

+ 9 - 2
include/bx/allocator.h

@@ -47,13 +47,20 @@ namespace bx
 		///
 		///
 		virtual ~AllocatorI() = 0;
 		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] _size If _ptr is set, and _size is 0, memory will be freed.
 		/// @param[in] _align Alignment.
 		/// @param[in] _align Alignment.
 		/// @param[in] _file Debug file path info.
 		/// @param[in] _file Debug file path info.
 		/// @param[in] _line Debug file line info.
 		/// @param[in] _line Debug file line info.
+		///
 		virtual void* realloc(
 		virtual void* realloc(
 			  void* _ptr
 			  void* _ptr
 			, size_t _size
 			, size_t _size