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:
35
docs/api/threading/task/setstatus.md
Normal file
35
docs/api/threading/task/setstatus.md
Normal file
@@ -0,0 +1,35 @@
|
||||
# ITask::SetStatus
|
||||
|
||||
```cpp
|
||||
void SetStatus(TaskStatus status)
|
||||
```
|
||||
|
||||
设置任务的当前状态。
|
||||
|
||||
**参数:**
|
||||
- `status` - 新的状态(参见 TaskStatus 枚举)
|
||||
|
||||
**返回:** 无
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**注意:** 正常情况下由 TaskSystem 管理状态。手动设置状态可能干扰任务系统的正常调度。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
class ConditionalTask : public ITask {
|
||||
public:
|
||||
void Execute() override {
|
||||
if (someCondition) {
|
||||
SetStatus(TaskStatus::Failed);
|
||||
return;
|
||||
}
|
||||
// 正常处理
|
||||
}
|
||||
};
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [ITask 总览](task.md) - 返回类总览
|
||||
Reference in New Issue
Block a user