docs: 重构 API 文档结构并修正源码准确性

- 重组文档目录结构: 每个模块的概述页移动到模块子目录
- 重命名 index.md 为 main.md
- 修正所有模块文档中的错误:
  - math: FromEuler→FromEulerAngles, TransformDirection 包含缩放, Box 是 OBB, Color::ToRGBA 格式
  - containers: 新增 operator==/!= 文档, 补充 std::hash DJB 算法细节
  - core: 修复 types 链接错误
  - debug: LogLevelToString 返回大写, timestamp 是秒, Profiler 空实现标注, Windows API vs ANSI
  - memory: 修复头文件路径, malloc vs operator new, 新增方法文档
  - resources: 修复 Shader/Texture 链接错误
  - threading: TaskSystem::Wait 空实现标注, ReadWriteLock 重入描述, LambdaTask 链接
- 验证: fix_links.py 确认 0 个断裂引用
This commit is contained in:
2026-03-19 00:22:30 +08:00
parent d0e16962c8
commit dc850d7739
1012 changed files with 26673 additions and 9222 deletions

View File

@@ -0,0 +1,37 @@
# ProxyAllocator::Allocate
```cpp
void* Allocate(size_t size, size_t alignment = 0) override;
```
分配内存并记录统计。调用转发到底层分配器,同时递增分配计数和总分配字节数,并更新峰值记录。
**参数:**
- `size` - 请求的字节数
- `alignment` - 内存对齐要求
**返回:** 分配成功返回指针,失败返回 `nullptr`
**复杂度:** O(1)(底层分配器复杂度 + 统计更新)
**示例:**
```cpp
#include <XCEngine/Memory/MemoryManager.h>
#include <XCEngine/Memory/ProxyAllocator.h>
IAllocator* sysAlloc = MemoryManager::Get().GetSystemAllocator();
ProxyAllocator proxy(sysAlloc, "TrackedAlloc");
void* p1 = proxy.Allocate(100);
void* p2 = proxy.Allocate(200);
void* p3 = proxy.Allocate(300, 16);
const auto& stats = proxy.GetStats();
printf("Total: %zu, Peak: %zu, Count: %zu\n",
stats.totalAllocated, stats.peakAllocated, stats.allocationCount);
```
## 相关文档
- [ProxyAllocator 总览](proxy-allocator.md) - 返回类总览

View File

@@ -0,0 +1,39 @@
# ProxyAllocator::Free
```cpp
void Free(void* ptr) override;
```
释放内存并记录统计。调用转发到底层分配器,同时更新统计信息:增加总释放计数(而非字节大小,因为 ProxyAllocator 不记录释放的字节数),并递减当前分配计数。
**参数:**
- `ptr` - 指向要释放的内存块
**返回:**
**复杂度:** O(1)(底层释放 + 统计更新)
**示例:**
```cpp
#include <XCEngine/Memory/MemoryManager.h>
#include <XCEngine/Memory/ProxyAllocator.h>
IAllocator* sysAlloc = MemoryManager::Get().GetSystemAllocator();
ProxyAllocator proxy(sysAlloc, "TrackedAlloc");
void* p1 = proxy.Allocate(512);
void* p2 = proxy.Allocate(256);
proxy.Free(p1);
proxy.Free(p2);
const auto& stats = proxy.GetStats();
printf("Total allocated: %zu, Total freed: %zu, Current: %zu\n",
stats.totalAllocated, stats.totalFreed,
stats.totalAllocated - stats.totalFreed);
```
## 相关文档
- [ProxyAllocator 总览](proxy-allocator.md) - 返回类总览

View File

@@ -0,0 +1,40 @@
# ProxyAllocator::GetStats
```cpp
const Stats& GetStats() const;
```
返回详细的统计信息结构体引用。包含累计分配、累计释放、峰值分配、分配次数和额外开销。返回 const 引用,无锁开销(内部已有互斥保护)。
**参数:**
**返回:** Stats 结构体 const 引用
**复杂度:** O(1)
**示例:**
```cpp
#include <XCEngine/Memory/MemoryManager.h>
#include <XCEngine/Memory/ProxyAllocator.h>
IAllocator* sysAlloc = MemoryManager::Get().GetSystemAllocator();
ProxyAllocator proxy(sysAlloc, "FrameData");
proxy.Allocate(1024);
proxy.Allocate(512);
proxy.Free(proxy.Allocate(256));
const ProxyAllocator::Stats& stats = proxy.GetStats();
printf("Total allocated: %zu bytes\n", stats.totalAllocated);
printf("Total freed: %zu bytes\n", stats.totalFreed);
printf("Peak allocated: %zu bytes\n", stats.peakAllocated);
printf("Allocation count: %zu\n", stats.allocationCount);
printf("Memory overhead: %zu bytes\n", stats.memoryOverhead);
printf("Current in use: %zu bytes\n",
stats.totalAllocated - stats.totalFreed);
```
## 相关文档
- [ProxyAllocator 总览](proxy-allocator.md) - 返回类总览

View File

@@ -0,0 +1,36 @@
# ProxyAllocator::ProxyAllocator
```cpp
ProxyAllocator(IAllocator* underlying, const char* name);
```
构造一个代理分配器,包装底层分配器并记录分配统计。所有 `Allocate``Free``Reallocate` 调用都会被转发到底层分配器,同时记录统计信息。名称用于日志和报告。
**参数:**
- `underlying` - 被包装的底层分配器,不能为 `nullptr`
- `name` - 代理分配器的名称字符串
**返回:**
**复杂度:** O(1)
**示例:**
```cpp
#include <XCEngine/Memory/MemoryManager.h>
#include <XCEngine/Memory/ProxyAllocator.h>
MemoryManager::Get().Initialize();
// 使用系统分配器作为底层
IAllocator* sysAlloc = MemoryManager::Get().GetSystemAllocator();
ProxyAllocator proxy(sysAlloc, "TempAllocations");
// 通过代理分配
void* ptr = proxy.Allocate(1024);
proxy.Free(ptr);
```
## 相关文档
- [ProxyAllocator 总览](proxy-allocator.md) - 返回类总览

View File

@@ -0,0 +1,40 @@
# ProxyAllocator::Reallocate
```cpp
void* Reallocate(void* ptr, size_t newSize) override;
```
重新分配内存并记录统计。调用转发到底层分配器。此方法仅更新 totalAllocated 统计为新大小,不记录原内存的释放(这是简化实现)。如果底层分配失败返回 `nullptr`,但原指针仍然有效。
**参数:**
- `ptr` - 现有内存块指针
- `newSize` - 新的字节大小
**返回:** 成功返回新指针,失败返回 `nullptr`
**复杂度:** O(n)(底层分配器 + 数据复制)
**示例:**
```cpp
#include <XCEngine/Memory/MemoryManager.h>
#include <XCEngine/Memory/ProxyAllocator.h>
IAllocator* sysAlloc = MemoryManager::Get().GetSystemAllocator();
ProxyAllocator proxy(sysAlloc, "TrackedAlloc");
void* p1 = proxy.Allocate(128);
void* p2 = proxy.Reallocate(p1, 256);
if (p2) {
// 重新分配成功
const auto& stats = proxy.GetStats();
printf("Reallocated: %zu bytes total\n", stats.totalAllocated);
} else {
// 失败p1 仍然有效
}
```
## 相关文档
- [ProxyAllocator 总览](proxy-allocator.md) - 返回类总览