docs: update memory and threading API docs
This commit is contained in:
@@ -4,6 +4,8 @@
|
||||
|
||||
**类型**: `class` (abstract interface)
|
||||
|
||||
**头文件**: `XCEngine/Memory/Allocator.h`
|
||||
|
||||
**描述**: 内存分配器抽象接口,定义标准分配协议。
|
||||
|
||||
## 概述
|
||||
@@ -16,24 +18,24 @@
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| `Allocate` | 分配内存 |
|
||||
| `Free` | 释放内存 |
|
||||
| `Reallocate` | 重新分配内存 |
|
||||
| [`Allocate`](allocate.md) | 分配内存 |
|
||||
| [`Free`](free.md) | 释放内存 |
|
||||
| [`Reallocate`](reallocate.md) | 重新分配内存 |
|
||||
|
||||
### 统计信息
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| `GetTotalAllocated` | 获取已分配总字节数 |
|
||||
| `GetTotalFreed` | 获取已释放总字节数 |
|
||||
| `GetPeakAllocated` | 获取峰值分配字节数 |
|
||||
| `GetAllocationCount` | 获取分配次数 |
|
||||
| [`GetTotalAllocated`](get-total-allocated.md) | 获取已分配总字节数 |
|
||||
| [`GetTotalFreed`](get-total-freed.md) | 获取已释放总字节数 |
|
||||
| [`GetPeakAllocated`](get-peak-allocated.md) | 获取峰值分配字节数 |
|
||||
| [`GetAllocationCount`](get-allocation-count.md) | 获取分配次数 |
|
||||
|
||||
### 元信息
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| `GetName` | 获取分配器名称 |
|
||||
| [`GetName`](get-name.md) | 获取分配器名称 |
|
||||
|
||||
## 使用示例
|
||||
|
||||
@@ -70,3 +72,4 @@ public:
|
||||
- [MemoryManager](../manager/manager.md) - 内存管理器
|
||||
- [LinearAllocator](../linear-allocator/linear-allocator.md) - 线性分配器
|
||||
- [PoolAllocator](../pool-allocator/pool-allocator.md) - 内存池分配器
|
||||
- [ProxyAllocator](../proxy-allocator/proxy-allocator.md) - 代理分配器
|
||||
|
||||
Reference in New Issue
Block a user