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,40 @@
# IAllocator::Free
```cpp
virtual void Free(void* ptr) = 0;
```
释放之前通过 `Allocate` 分配的内存块。如果 `ptr``nullptr`,则此调用无效果。部分分配器(如 LinearAllocator可能不支持此操作。
**参数:**
- `ptr` - 指向要释放内存块的指针
**返回:**
**复杂度:** O(1)(固定块释放)或 O(n)(需要搜索)
**示例:**
```cpp
#include <XCEngine/Memory/IAllocator.h>
class MyAllocator : public IAllocator {
public:
void* Allocate(size_t size, size_t alignment = 0) override {
return ::operator new(size);
}
void Free(void* ptr) override {
if (ptr) ::operator delete(ptr);
}
// ... 其他方法实现
};
MyAllocator alloc;
void* ptr = alloc.Allocate(512);
alloc.Free(ptr); // 释放内存
```
## 相关文档
- [IAllocator 总览](allocator.md) - 返回类总览