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:
37
docs/api/threading/task-system/initialize.md
Normal file
37
docs/api/threading/task-system/initialize.md
Normal file
@@ -0,0 +1,37 @@
|
||||
# TaskSystem::Initialize
|
||||
|
||||
```cpp
|
||||
void Initialize(const TaskSystemConfig& config)
|
||||
```
|
||||
|
||||
初始化任务系统,创建工作线程并启动任务调度。
|
||||
|
||||
**参数:**
|
||||
- `config` - 任务系统配置(参见 TaskSystemConfig)
|
||||
|
||||
**返回:** 无
|
||||
|
||||
**复杂度:** O(n),n 为 workerThreadCount
|
||||
|
||||
**注意:**
|
||||
- 多次调用将先关闭已有系统再重新初始化。
|
||||
- 应在主线程中调用,在任何任务提交之前完成初始化。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
TaskSystemConfig config;
|
||||
config.workerThreadCount = std::thread::hardware_concurrency();
|
||||
config.enableTaskProfiling = true;
|
||||
config.stealTasks = true;
|
||||
config.maxTaskQueueSize = 2048;
|
||||
|
||||
TaskSystem::Get().Initialize(config);
|
||||
printf("TaskSystem started with %u workers\n",
|
||||
TaskSystem::Get().GetWorkerThreadCount());
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [TaskSystem 总览](task-system.md) - 返回类总览
|
||||
- [Shutdown](shutdown.md) - 关闭任务系统
|
||||
Reference in New Issue
Block a user