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:
44
docs/api/threading/task-group/adddependency.md
Normal file
44
docs/api/threading/task-group/adddependency.md
Normal file
@@ -0,0 +1,44 @@
|
||||
# TaskGroup::AddDependency
|
||||
|
||||
```cpp
|
||||
void AddDependency(uint64_t taskId, uint64_t dependsOn)
|
||||
```
|
||||
|
||||
为任务添加依赖关系。被依赖的任务必须先完成,当前任务才会开始执行。
|
||||
|
||||
**参数:**
|
||||
- `taskId` - 任务 ID(需要等待的任务)
|
||||
- `dependsOn` - 依赖的父任务 ID
|
||||
|
||||
**返回:** 无
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**注意:**
|
||||
- 如果被依赖的任务不存在或已完成,调用无效果。
|
||||
- 支持添加多个依赖,但不支持循环依赖。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
TaskGroup* group = TaskSystem::Get().CreateTaskGroup();
|
||||
|
||||
uint64_t init = group->AddTask([]() { Initialize(); });
|
||||
uint64_t task1 = group->AddTask([]() { Phase1(); });
|
||||
uint64_t task2 = group->AddTask([]() { Phase2(); });
|
||||
uint64_t cleanup = group->AddTask([]() { Cleanup(); });
|
||||
|
||||
// task1 和 task2 依赖 init
|
||||
group->AddDependency(task1, init);
|
||||
group->AddDependency(task2, init);
|
||||
|
||||
// cleanup 依赖 task1 和 task2
|
||||
group->AddDependency(cleanup, task1);
|
||||
group->AddDependency(cleanup, task2);
|
||||
|
||||
group->Wait();
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [TaskGroup 总览](task-group.md) - 返回类总览
|
||||
Reference in New Issue
Block a user