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:
32
docs/api/threading/task/release.md
Normal file
32
docs/api/threading/task/release.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# ITask::Release
|
||||
|
||||
```cpp
|
||||
void Release()
|
||||
```
|
||||
|
||||
减少引用计数。当引用计数归零时,对象会自动 delete 自身。
|
||||
|
||||
**参数:** 无
|
||||
|
||||
**返回:** 无
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**注意:**
|
||||
- 任务提交给 TaskSystem 后,TaskSystem 会自动管理引用计数。
|
||||
- 当任务完成且无人持有引用时,任务对象将被自动销毁。
|
||||
- 不要在任务执行过程中调用 Release。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
ITask* task = new MyTask();
|
||||
task->AddRef(); // 引用计数 = 2
|
||||
TaskSystem::Get().Submit(std::unique_ptr<ITask>(task)); // 引用计数 = 1
|
||||
task->Release(); // 引用计数 = 0,任务被 delete
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [ITask 总览](task.md) - 返回类总览
|
||||
- [AddRef](addref.md) - 增加引用计数
|
||||
Reference in New Issue
Block a user