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,44 @@
# LogCategory
**命名空间**: `XCEngine::Debug`
**类型**: `enum class`
**描述**: 日志分类枚举,定义日志的来源模块。
## 概述
`LogCategory` 枚举定义了日志的分类,用于区分不同引擎模块的日志输出。
## 枚举值
| 值 | 说明 |
|----|------|
| `General` | 通用 |
| `Rendering` | 渲染 |
| `Physics` | 物理 |
| `Audio` | 音频 |
| `Scripting` | 脚本 |
| `Network` | 网络 |
| `Memory` | 内存 |
| `Threading` | 线程 |
| `FileSystem` | 文件系统 |
| `Custom` | 自定义 |
## 辅助函数
| 函数 | 描述 |
|------|------|
| `const char* LogCategoryToString(LogCategory category)` | [将日志分类转换为字符串](logcategorytostring.md) |
## 使用示例
```cpp
Logger::Get().SetCategoryEnabled(LogCategory::Network, false);
XE_LOG(LogCategory::Rendering, LogLevel::Info, "Draw call submitted");
```
## 相关文档
- [Debug 模块总览](../debug.md) - 返回模块总览
- [Logger](../logger/logger.md) - 日志记录器

View File

@@ -0,0 +1,28 @@
# LogCategoryToString
```cpp
const char* LogCategoryToString(LogCategory category)
```
`LogCategory` 枚举值转换为可读字符串。
**参数:**
- `category` - 日志分类
**返回:** 对应分类的字符串("General", "Rendering", "Physics" 等)
**复杂度:** O(1)
**示例:**
```cpp
#include <XCEngine/Debug/LogCategory.h>
XCEngine::Debug::LogCategory cat = XCEngine::Debug::LogCategory::Rendering;
const char* str = XCEngine::Debug::LogCategoryToString(cat);
// str == "Rendering"
```
## 相关文档
- [LogCategory 总览](logcategory.md) - 返回类总览