docs: rebuild Threading API content

This commit is contained in:
2026-03-26 20:59:59 +08:00
parent 9a2d77b81d
commit 8f486611d5
78 changed files with 1648 additions and 1061 deletions

View File

@@ -1,31 +1,35 @@
# TaskSystem::DestroyTaskGroup
公开方法,详见头文件声明
销毁一个由任务系统创建的任务组
```cpp
void DestroyTaskGroup(TaskGroup* group);
```
该方法声明于 `XCEngine/Threading/TaskSystem.h`,当前页面用于固定 `TaskSystem` 类目录下的方法级 canonical 路径。
## 行为说明
**参数:**
- `group` - 参数语义详见头文件声明。
当前实现会:
**返回:** `void` - 无返回
1.`group == nullptr`,直接返回。
2.`m_groupMutex` 保护下,从 `m_taskGroups` 中查找并移除该指针。
3. 在锁外执行 `delete group`
**示例:**
## 参数
```cpp
#include <XCEngine/Threading/TaskSystem.h>
- `group` - 要销毁的任务组。
void Example() {
XCEngine::Threading::TaskSystem object;
// 根据上下文补齐参数后调用 TaskSystem::DestroyTaskGroup(...)
(void)object;
}
```
## 返回值
-
## 当前实现限制
- 当前不会先 [Cancel](../TaskGroup/Cancel.md) 或 [Wait](../TaskGroup/Wait.md)。
- 若任务组内部已有通过 [TaskGroup::AddTask](../TaskGroup/AddTask.md) 存进去的任务对象,`delete group` 也不会释放这些裸任务指针。
- 如果传入的指针不在 `m_taskGroups` 列表里,当前实现仍会直接 `delete group`
## 相关文档
- [返回类总览](TaskSystem.md)
- [返回模块目录](../Threading.md)
- [返回类总览](TaskSystem.md)
- [CreateTaskGroup](CreateTaskGroup.md)
- [TaskGroup](../TaskGroup/TaskGroup.md)