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:
39
docs/api/threading/task-group/waitfor.md
Normal file
39
docs/api/threading/task-group/waitfor.md
Normal file
@@ -0,0 +1,39 @@
|
||||
# TaskGroup::WaitFor
|
||||
|
||||
```cpp
|
||||
bool WaitFor(std::chrono::milliseconds timeout)
|
||||
```
|
||||
|
||||
等待任务组中所有任务完成,可在超时后返回。
|
||||
|
||||
**参数:**
|
||||
- `timeout` - 最大等待时间
|
||||
|
||||
**返回:** `bool` - 所有任务在超时前完成返回 true,超时返回 false
|
||||
|
||||
**复杂度:** O(n)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
TaskGroup* group = TaskSystem::Get().CreateTaskGroup();
|
||||
|
||||
for (int i = 0; i < 5; ++i) {
|
||||
group->AddTask([i]() {
|
||||
Thread::Sleep(i * 100);
|
||||
printf("Task %d done\n", i);
|
||||
});
|
||||
}
|
||||
|
||||
if (group->WaitFor(std::chrono::seconds(1))) {
|
||||
printf("All tasks completed within 1 second\n");
|
||||
} else {
|
||||
printf("Timeout! Some tasks still running\n");
|
||||
printf("Progress: %.1f%%\n", group->GetProgress() * 100.0f);
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [TaskGroup 总览](task-group.md) - 返回类总览
|
||||
- [Wait](wait.md) - 无超时等待
|
||||
Reference in New Issue
Block a user