Add doc comment to operator[] overload in coral lib
This commit is contained in:
parent
38e4572352
commit
868297dfb7
@ -278,7 +278,11 @@ export void operator delete(void * pointer, coral::allocator & allocator) {
|
||||
}
|
||||
|
||||
/**
|
||||
* If `pointer` is a non-`nullptr` value, the referenced memory block will be deallocated using
|
||||
* `allocator`. Otherwise, the function has no side-effects.
|
||||
*
|
||||
* *Note*: passing a `pointer` value that was not allocated by `allocator` will result in erroneous
|
||||
* behavior defined by the [coral::allocator] implementation.
|
||||
*/
|
||||
export void operator delete[](void * pointer, coral::allocator & allocator) {
|
||||
return allocator.deallocate(pointer);
|
||||
|
Loading…
x
Reference in New Issue
Block a user