docs: rebuild Memory API content
This commit is contained in:
@@ -1,29 +1,31 @@
|
||||
# PoolAllocator::~PoolAllocator()
|
||||
# PoolAllocator::Destructor
|
||||
|
||||
销毁对象并释放相关资源。
|
||||
销毁整个池并释放底层大块内存。
|
||||
|
||||
```cpp
|
||||
~PoolAllocator() override;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Memory/PoolAllocator.h`,当前页面用于固定 `PoolAllocator` 类目录下的方法级 canonical 路径。
|
||||
## 行为说明
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
当前实现只做一件事:
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Memory/PoolAllocator.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Memory::PoolAllocator object;
|
||||
// 对象离开作用域时会自动触发析构。
|
||||
}
|
||||
std::free(m_memory);
|
||||
```
|
||||
|
||||
它不会遍历池中的对象,也不会为池中存放的 C++ 对象调用析构函数。换句话说,`PoolAllocator` 只负责原始内存块,不负责对象生命周期管理。
|
||||
|
||||
## 返回值
|
||||
|
||||
- 无。
|
||||
|
||||
## 使用建议
|
||||
|
||||
- 如果 block 中放的是需要析构的对象,应由调用方先显式析构对象,再销毁分配器。
|
||||
- 分配器销毁后,之前返回的所有 block 指针都会变成悬空指针。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](PoolAllocator.md)
|
||||
- [返回模块目录](../Memory.md)
|
||||
- [返回类型总览](PoolAllocator.md)
|
||||
- [Free](Free.md)
|
||||
|
||||
Reference in New Issue
Block a user