refactor api documentation structure

docs/api/XCEngine/Memory/MemoryManager/CreateLinearAllocator.md

@@ -0,0 +1,31 @@
+# MemoryManager::CreateLinearAllocator
+
+创建新对象或资源。
+
+```cpp
+std::unique_ptr<LinearAllocator> CreateLinearAllocator(size_t size);
+```
+
+该方法声明于 `XCEngine/Memory/MemoryManager.h`，当前页面用于固定 `MemoryManager` 类目录下的方法级 canonical 路径。
+
+**参数：**
+- `size` - 参数语义详见头文件声明。
+
+**返回：** `std::unique_ptr<LinearAllocator>` - 返回值语义详见头文件声明。
+
+**示例：**
+
+```cpp
+#include <XCEngine/Memory/MemoryManager.h>
+
+void Example() {
+    XCEngine::Memory::MemoryManager object;
+    // 根据上下文补齐参数后调用 MemoryManager::CreateLinearAllocator(...)。
+    (void)object;
+}
+```
+
+## 相关文档
+
+- [返回类总览](MemoryManager.md)
+- [返回模块目录](../Memory.md)

docs/api/XCEngine/Memory/MemoryManager/CreatePoolAllocator.md

@@ -0,0 +1,32 @@
+# MemoryManager::CreatePoolAllocator
+
+创建新对象或资源。
+
+```cpp
+std::unique_ptr<PoolAllocator> CreatePoolAllocator(size_t blockSize, size_t count);
+```
+
+该方法声明于 `XCEngine/Memory/MemoryManager.h`，当前页面用于固定 `MemoryManager` 类目录下的方法级 canonical 路径。
+
+**参数：**
+- `blockSize` - 参数语义详见头文件声明。
+- `count` - 参数语义详见头文件声明。
+
+**返回：** `std::unique_ptr<PoolAllocator>` - 返回值语义详见头文件声明。
+
+**示例：**
+
+```cpp
+#include <XCEngine/Memory/MemoryManager.h>
+
+void Example() {
+    XCEngine::Memory::MemoryManager object;
+    // 根据上下文补齐参数后调用 MemoryManager::CreatePoolAllocator(...)。
+    (void)object;
+}
+```
+
+## 相关文档
+
+- [返回类总览](MemoryManager.md)
+- [返回模块目录](../Memory.md)

docs/api/XCEngine/Memory/MemoryManager/CreateProxyAllocator.md

@@ -0,0 +1,31 @@
+# MemoryManager::CreateProxyAllocator
+
+创建新对象或资源。
+
+```cpp
+std::unique_ptr<ProxyAllocator> CreateProxyAllocator(const char* name);
+```
+
+该方法声明于 `XCEngine/Memory/MemoryManager.h`，当前页面用于固定 `MemoryManager` 类目录下的方法级 canonical 路径。
+
+**参数：**
+- `name` - 参数语义详见头文件声明。
+
+**返回：** `std::unique_ptr<ProxyAllocator>` - 返回值语义详见头文件声明。
+
+**示例：**
+
+```cpp
+#include <XCEngine/Memory/MemoryManager.h>
+
+void Example() {
+    XCEngine::Memory::MemoryManager object;
+    // 根据上下文补齐参数后调用 MemoryManager::CreateProxyAllocator(...)。
+    (void)object;
+}
+```
+
+## 相关文档
+
+- [返回类总览](MemoryManager.md)
+- [返回模块目录](../Memory.md)

docs/api/XCEngine/Memory/MemoryManager/DumpMemoryLeaks.md

@@ -0,0 +1,30 @@
+# MemoryManager::DumpMemoryLeaks
+
+公开方法，详见头文件声明。
+
+```cpp
+void DumpMemoryLeaks();
+```
+
+该方法声明于 `XCEngine/Memory/MemoryManager.h`，当前页面用于固定 `MemoryManager` 类目录下的方法级 canonical 路径。
+
+**参数：** 无。
+
+**返回：** `void` - 无返回值。
+
+**示例：**
+
+```cpp
+#include <XCEngine/Memory/MemoryManager.h>
+
+void Example() {
+    XCEngine::Memory::MemoryManager object;
+    // 根据上下文补齐参数后调用 MemoryManager::DumpMemoryLeaks(...)。
+    (void)object;
+}
+```
+
+## 相关文档
+
+- [返回类总览](MemoryManager.md)
+- [返回模块目录](../Memory.md)

docs/api/XCEngine/Memory/MemoryManager/GenerateMemoryReport.md

@@ -0,0 +1,30 @@
+# MemoryManager::GenerateMemoryReport
+
+公开方法，详见头文件声明。
+
+```cpp
+void GenerateMemoryReport();
+```
+
+该方法声明于 `XCEngine/Memory/MemoryManager.h`，当前页面用于固定 `MemoryManager` 类目录下的方法级 canonical 路径。
+
+**参数：** 无。
+
+**返回：** `void` - 无返回值。
+
+**示例：**
+
+```cpp
+#include <XCEngine/Memory/MemoryManager.h>
+
+void Example() {
+    XCEngine::Memory::MemoryManager object;
+    // 根据上下文补齐参数后调用 MemoryManager::GenerateMemoryReport(...)。
+    (void)object;
+}
+```
+
+## 相关文档
+
+- [返回类总览](MemoryManager.md)
+- [返回模块目录](../Memory.md)

docs/api/XCEngine/Memory/MemoryManager/Get.md

@@ -0,0 +1,29 @@
+# MemoryManager::Get
+
+获取相关状态或对象。
+
+```cpp
+static MemoryManager& Get();
+```
+
+该方法声明于 `XCEngine/Memory/MemoryManager.h`，当前页面用于固定 `MemoryManager` 类目录下的方法级 canonical 路径。
+
+**参数：** 无。
+
+**返回：** `MemoryManager&` - 返回值语义详见头文件声明。
+
+**示例：**
+
+```cpp
+#include <XCEngine/Memory/MemoryManager.h>
+
+void Example() {
+    auto& instance = XCEngine::Memory::MemoryManager::Get();
+    (void)instance;
+}
+```
+
+## 相关文档
+
+- [返回类总览](MemoryManager.md)
+- [返回模块目录](../Memory.md)

docs/api/XCEngine/Memory/MemoryManager/GetSystemAllocator.md

@@ -0,0 +1,30 @@
+# MemoryManager::GetSystemAllocator
+
+获取相关状态或对象。
+
+```cpp
+IAllocator* GetSystemAllocator();
+```
+
+该方法声明于 `XCEngine/Memory/MemoryManager.h`，当前页面用于固定 `MemoryManager` 类目录下的方法级 canonical 路径。
+
+**参数：** 无。
+
+**返回：** `IAllocator*` - 返回值语义详见头文件声明。
+
+**示例：**
+
+```cpp
+#include <XCEngine/Memory/MemoryManager.h>
+
+void Example() {
+    XCEngine::Memory::MemoryManager object;
+    // 根据上下文补齐参数后调用 MemoryManager::GetSystemAllocator(...)。
+    (void)object;
+}
+```
+
+## 相关文档
+
+- [返回类总览](MemoryManager.md)
+- [返回模块目录](../Memory.md)

docs/api/XCEngine/Memory/MemoryManager/Initialize.md

@@ -0,0 +1,30 @@
+# MemoryManager::Initialize
+
+初始化内部状态。
+
+```cpp
+void Initialize();
+```
+
+该方法声明于 `XCEngine/Memory/MemoryManager.h`，当前页面用于固定 `MemoryManager` 类目录下的方法级 canonical 路径。
+
+**参数：** 无。
+
+**返回：** `void` - 无返回值。
+
+**示例：**
+
+```cpp
+#include <XCEngine/Memory/MemoryManager.h>
+
+void Example() {
+    XCEngine::Memory::MemoryManager object;
+    // 根据上下文补齐参数后调用 MemoryManager::Initialize(...)。
+    (void)object;
+}
+```
+
+## 相关文档
+
+- [返回类总览](MemoryManager.md)
+- [返回模块目录](../Memory.md)

docs/api/XCEngine/Memory/MemoryManager/MemoryManager.md

@@ -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) - 返回顶层索引

docs/api/XCEngine/Memory/MemoryManager/SetTrackAllocations.md

@@ -0,0 +1,31 @@
+# MemoryManager::SetTrackAllocations
+
+设置相关状态或配置。
+
+```cpp
+void SetTrackAllocations(bool track);
+```
+
+该方法声明于 `XCEngine/Memory/MemoryManager.h`，当前页面用于固定 `MemoryManager` 类目录下的方法级 canonical 路径。
+
+**参数：**
+- `track` - 参数语义详见头文件声明。
+
+**返回：** `void` - 无返回值。
+
+**示例：**
+
+```cpp
+#include <XCEngine/Memory/MemoryManager.h>
+
+void Example() {
+    XCEngine::Memory::MemoryManager object;
+    // 根据上下文补齐参数后调用 MemoryManager::SetTrackAllocations(...)。
+    (void)object;
+}
+```
+
+## 相关文档
+
+- [返回类总览](MemoryManager.md)
+- [返回模块目录](../Memory.md)

docs/api/XCEngine/Memory/MemoryManager/Shutdown.md

@@ -0,0 +1,30 @@
+# MemoryManager::Shutdown
+
+关闭并清理内部状态。
+
+```cpp
+void Shutdown();
+```
+
+该方法声明于 `XCEngine/Memory/MemoryManager.h`，当前页面用于固定 `MemoryManager` 类目录下的方法级 canonical 路径。
+
+**参数：** 无。
+
+**返回：** `void` - 无返回值。
+
+**示例：**
+
+```cpp
+#include <XCEngine/Memory/MemoryManager.h>
+
+void Example() {
+    XCEngine::Memory::MemoryManager object;
+    // 根据上下文补齐参数后调用 MemoryManager::Shutdown(...)。
+    (void)object;
+}
+```
+
+## 相关文档
+
+- [返回类总览](MemoryManager.md)
+- [返回模块目录](../Memory.md)