kayomn/ona
1
0
Fork 0
Code Issues 8 Pull Requests Projects 4 Releases Activity

Add doc comment to operator[] overload in coral lib

Browse Source
This commit is contained in:
kayomn 2023-02-25 16:42:44 +00:00
parent 38e4572352
commit 868297dfb7
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
source/coral.cpp
View File

@ -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) { export void operator delete[](void * pointer, coral::allocator & allocator) {
return allocator.deallocate(pointer); return allocator.deallocate(pointer);