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/wait.md
Normal file
37
docs/api/threading/task-system/wait.md
Normal file
@@ -0,0 +1,37 @@
|
||||
# TaskSystem::Wait
|
||||
|
||||
```cpp
|
||||
void Wait(uint64_t taskId)
|
||||
```
|
||||
|
||||
**注意:** 此方法当前为空实现,不执行任何操作。
|
||||
|
||||
阻塞当前线程,等待指定任务完成(功能暂未实现)。
|
||||
|
||||
**参数:**
|
||||
- `taskId` - 要等待的任务 ID
|
||||
|
||||
**返回:** 无
|
||||
|
||||
**复杂度:** N/A(空实现)
|
||||
|
||||
**建议:** 建议使用 `TaskGroup::Wait` 代替此方法。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
uint64_t id = TaskSystem::Get().Submit([]() {
|
||||
for (int i = 0; i < 1000000; ++i) {
|
||||
Compute(i);
|
||||
}
|
||||
});
|
||||
|
||||
printf("Waiting for task...\n");
|
||||
// 注意:当前实现为空,建议使用 TaskGroup 来等待任务完成
|
||||
TaskSystem::Get().Wait(id);
|
||||
printf("Task completed\n");
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [TaskSystem 总览](task-system.md) - 返回类总览
|
||||
Reference in New Issue
Block a user