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:
45
docs/api/threading/task-group/cancel.md
Normal file
45
docs/api/threading/task-group/cancel.md
Normal file
@@ -0,0 +1,45 @@
|
||||
# TaskGroup::Cancel
|
||||
|
||||
```cpp
|
||||
void Cancel()
|
||||
```
|
||||
|
||||
取消任务组中所有尚未执行的任务。正在执行的任务将不受影响。
|
||||
|
||||
**参数:** 无
|
||||
|
||||
**返回:** 无
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**注意:**
|
||||
- 已完成的任务不受影响。
|
||||
- 正在执行的任务继续执行直到完成。
|
||||
- 调用后所有 Wait/WaitFor 会立即返回。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
TaskGroup* group = TaskSystem::Get().CreateTaskGroup();
|
||||
|
||||
for (int i = 0; i < 100; ++i) {
|
||||
group->AddTask([i]() {
|
||||
if (ShouldCancel()) {
|
||||
return; // 检查取消状态
|
||||
}
|
||||
ProcessLongTask(i);
|
||||
});
|
||||
}
|
||||
|
||||
// 如果用户点击取消按钮
|
||||
if (userClickedCancel) {
|
||||
group->Cancel();
|
||||
printf("Tasks canceled. Progress: %.1f%%\n", group->GetProgress() * 100.0f);
|
||||
}
|
||||
|
||||
group->Wait();
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [TaskGroup 总览](task-group.md) - 返回类总览
|
||||
Reference in New Issue
Block a user