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:
43
docs/api/threading/task/execute.md
Normal file
43
docs/api/threading/task/execute.md
Normal file
@@ -0,0 +1,43 @@
|
||||
# ITask::Execute
|
||||
|
||||
```cpp
|
||||
virtual void Execute() = 0
|
||||
```
|
||||
|
||||
任务执行逻辑(纯虚方法)。用户必须在派生类中实现此方法以定义任务的具体行为。
|
||||
|
||||
**参数:** 无
|
||||
|
||||
**返回:** 无
|
||||
|
||||
**复杂度:** 取决于具体任务实现
|
||||
|
||||
**注意:**
|
||||
- 此方法由 TaskSystem 的工作线程调用。
|
||||
- 任务执行期间如发生未捕获异常,行为未定义。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
class ComputeTask : public ITask {
|
||||
public:
|
||||
explicit ComputeTask(int n) : m_n(n) {}
|
||||
|
||||
void Execute() override {
|
||||
int result = 0;
|
||||
for (int i = 0; i < m_n; ++i) {
|
||||
result += i;
|
||||
}
|
||||
printf("Result: %d\n", result);
|
||||
}
|
||||
|
||||
private:
|
||||
int m_n;
|
||||
};
|
||||
|
||||
TaskSystem::Get().Submit(std::make_unique<ComputeTask>(100));
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [ITask 总览](task.md) - 返回类总览
|
||||
Reference in New Issue
Block a user