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,27 @@
# TaskSystemConfig::enableTaskProfiling
```cpp
bool enableTaskProfiling = true
```
是否启用任务性能分析。启用后系统会记录任务的执行时间、等待时间等统计信息,可用于性能调试。
**类型:** `bool`
**默认值:** `true`
**示例:**
```cpp
TaskSystemConfig config;
config.workerThreadCount = 4;
config.enableTaskProfiling = true; // 启用分析
#ifdef NDEBUG
config.enableTaskProfiling = false; // 发布版本关闭
#endif
```
## 相关文档
- [TaskSystemConfig 总览](tasksystemconfig.md) - 返回类总览

View File

@@ -0,0 +1,22 @@
# TaskSystemConfig::maxTaskQueueSize
```cpp
uint32_t maxTaskQueueSize = 1024
```
任务队列的最大容量。当队列满时,新提交的任务将阻塞直到有空间。
**类型:** `uint32_t`
**默认值:** `1024`
**示例:**
```cpp
TaskSystemConfig config;
config.maxTaskQueueSize = 4096; // 允许更大的队列
```
## 相关文档
- [TaskSystemConfig 总览](tasksystemconfig.md) - 返回类总览

View File

@@ -0,0 +1,23 @@
# TaskSystemConfig::stealTasks
```cpp
bool stealTasks = true
```
是否启用工作窃取。当启用时,空闲的工作线程可以从其他繁忙线程的任务队列中窃取任务,提高整体吞吐率。
**类型:** `bool`
**默认值:** `true`
**示例:**
```cpp
TaskSystemConfig config;
config.workerThreadCount = 8;
config.stealTasks = true; // 启用工作窃取以获得更好负载均衡
```
## 相关文档
- [TaskSystemConfig 总览](tasksystemconfig.md) - 返回类总览

View File

@@ -0,0 +1,36 @@
# TaskSystemConfig
**命名空间**: `XCEngine::Threading`
**类型**: `struct`
**头文件**: `XCEngine/Threading/TaskSystemConfig.h`
**描述**: 任务系统配置结构体,用于初始化 TaskSystem 的行为参数。
## 结构体成员
| 成员 | 类型 | 描述 | 默认值 |
|------|------|------|--------|
| [`workerThreadCount`](workerthreadcount.md) | `uint32_t` | 工作线程数量0=自动检测 CPU 核心数) | 0 |
| [`enableTaskProfiling`](enabletaskprofiling.md) | `bool` | 启用任务性能分析 | true |
| [`stealTasks`](stealtasks.md) | `bool` | 启用工作窃取(负载均衡) | true |
| [`maxTaskQueueSize`](maxtaskqueuesize.md) | `uint32_t` | 最大任务队列大小 | 1024 |
| [`threadStackSize`](threadstacksize.md) | `uint32_t` | 线程栈大小0=系统默认) | 0 |
## 使用示例
```cpp
TaskSystemConfig config;
config.workerThreadCount = std::thread::hardware_concurrency();
config.enableTaskProfiling = true;
config.stealTasks = true;
config.maxTaskQueueSize = 2048;
TaskSystem::Get().Initialize(config);
```
## 相关文档
- [TaskSystem](../task-system/task-system.md) - 任务系统
- [../threading/threading.md](../threading.md) - 模块总览

View File

@@ -0,0 +1,26 @@
# TaskSystemConfig::threadStackSize
```cpp
uint32_t threadStackSize = 0
```
工作线程的栈大小(字节)。值为 0 时使用系统默认值。
**类型:** `uint32_t`
**默认值:** `0`(使用系统默认)
**示例:**
```cpp
TaskSystemConfig config;
config.workerThreadCount = 4;
config.threadStackSize = 1024 * 1024; // 1MB 栈大小
TaskSystemConfig defaultConfig;
defaultConfig.threadStackSize = 0; // 使用系统默认
```
## 相关文档
- [TaskSystemConfig 总览](tasksystemconfig.md) - 返回类总览

View File

@@ -0,0 +1,25 @@
# TaskSystemConfig::workerThreadCount
```cpp
uint32_t workerThreadCount = 0
```
工作线程数量。当值为 0 时,任务系统自动检测 `std::thread::hardware_concurrency()` 并使用该值。
**类型:** `uint32_t`
**默认值:** `0`(自动检测)
**示例:**
```cpp
TaskSystemConfig config;
config.workerThreadCount = 4; // 使用 4 个工作线程
TaskSystemConfig autoConfig;
autoConfig.workerThreadCount = 0; // 自动检测(推荐)
```
## 相关文档
- [TaskSystemConfig 总览](tasksystemconfig.md) - 返回类总览