refactor api documentation structure
This commit is contained in:
43
docs/api/XCEngine/Memory/PoolAllocator/PoolAllocator.md
Normal file
43
docs/api/XCEngine/Memory/PoolAllocator/PoolAllocator.md
Normal file
@@ -0,0 +1,43 @@
|
||||
# PoolAllocator
|
||||
|
||||
**命名空间**: `XCEngine::Memory`
|
||||
|
||||
**类型**: `class`
|
||||
|
||||
**头文件**: `XCEngine/Memory/PoolAllocator.h`
|
||||
|
||||
**描述**: 定义 `XCEngine/Memory` 子目录中的 `PoolAllocator` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`PoolAllocator.h` 是 `XCEngine/Memory` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `PoolAllocator` | `class` | 继承自 `IAllocator` 的公开声明。 |
|
||||
|
||||
## 公共方法
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [PoolAllocator()](Constructor.md) | 构造对象。 |
|
||||
| [~PoolAllocator()](Destructor.md) | 销毁对象并释放相关资源。 |
|
||||
| [Allocate](Allocate.md) | 公开方法,详见头文件声明。 |
|
||||
| [Free](Free.md) | 公开方法,详见头文件声明。 |
|
||||
| [Reallocate](Reallocate.md) | 公开方法,详见头文件声明。 |
|
||||
| [Contains](Contains.md) | 公开方法,详见头文件声明。 |
|
||||
| [GetBlockSize](GetBlockSize.md) | 获取相关状态或对象。 |
|
||||
| [GetFreeBlockCount](GetFreeBlockCount.md) | 获取相关状态或对象。 |
|
||||
| [GetTotalBlockCount](GetTotalBlockCount.md) | 获取相关状态或对象。 |
|
||||
| [GetName](GetName.md) | 获取相关状态或对象。 |
|
||||
| [GetTotalAllocated](GetTotalAllocated.md) | 获取相关状态或对象。 |
|
||||
| [GetTotalFreed](GetTotalFreed.md) | 获取相关状态或对象。 |
|
||||
| [GetPeakAllocated](GetPeakAllocated.md) | 获取相关状态或对象。 |
|
||||
| [GetAllocationCount](GetAllocationCount.md) | 获取相关状态或对象。 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Memory.md) - 返回 `Memory` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
Reference in New Issue
Block a user