refactor api documentation structure

This commit is contained in:
2026-03-26 16:45:24 +08:00
parent 45842e961e
commit 6244b586bb
4389 changed files with 80504 additions and 69241 deletions

View File

@@ -0,0 +1,39 @@
# MemoryManager
**命名空间**: `XCEngine::Memory`
**类型**: `class (singleton)`
**头文件**: `XCEngine/Memory/MemoryManager.h`
**描述**: 定义 `XCEngine/Memory` 子目录中的 `MemoryManager` public API。
## 概述
`MemoryManager.h``XCEngine/Memory` 子目录 下的 public header当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
## 声明概览
| 声明 | 类型 | 说明 |
|------|------|------|
| `MemoryManager` | `class` | 头文件中的公开声明。 |
## 公共方法
| 方法 | 描述 |
|------|------|
| [Get](Get.md) | 获取相关状态或对象。 |
| [Initialize](Initialize.md) | 初始化内部状态。 |
| [Shutdown](Shutdown.md) | 关闭并清理内部状态。 |
| [GetSystemAllocator](GetSystemAllocator.md) | 获取相关状态或对象。 |
| [CreateLinearAllocator](CreateLinearAllocator.md) | 创建新对象或资源。 |
| [CreatePoolAllocator](CreatePoolAllocator.md) | 创建新对象或资源。 |
| [CreateProxyAllocator](CreateProxyAllocator.md) | 创建新对象或资源。 |
| [SetTrackAllocations](SetTrackAllocations.md) | 设置相关状态或配置。 |
| [DumpMemoryLeaks](DumpMemoryLeaks.md) | 公开方法,详见头文件声明。 |
| [GenerateMemoryReport](GenerateMemoryReport.md) | 公开方法,详见头文件声明。 |
## 相关文档
- [当前目录](../Memory.md) - 返回 `Memory` 平行目录
- [API 总索引](../../../main.md) - 返回顶层索引