refactor api documentation structure
This commit is contained in:
39
docs/api/XCEngine/Threading/TaskGroup/TaskGroup.md
Normal file
39
docs/api/XCEngine/Threading/TaskGroup/TaskGroup.md
Normal file
@@ -0,0 +1,39 @@
|
||||
# TaskGroup
|
||||
|
||||
**命名空间**: `XCEngine::Threading`
|
||||
|
||||
**类型**: `class`
|
||||
|
||||
**头文件**: `XCEngine/Threading/TaskGroup.h`
|
||||
|
||||
**描述**: 定义 `XCEngine/Threading` 子目录中的 `TaskGroup` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`TaskGroup.h` 是 `XCEngine/Threading` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `TaskGroup` | `class` | 头文件中的公开声明。 |
|
||||
|
||||
## 公共方法
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [TaskGroup()](Constructor.md) | 构造对象。 |
|
||||
| [~TaskGroup()](Destructor.md) | 销毁对象并释放相关资源。 |
|
||||
| [AddTask](AddTask.md) | 添加元素或建立关联。 |
|
||||
| [AddDependency](AddDependency.md) | 添加元素或建立关联。 |
|
||||
| [Wait](Wait.md) | 公开方法,详见头文件声明。 |
|
||||
| [WaitFor](WaitFor.md) | 公开方法,详见头文件声明。 |
|
||||
| [SetCompleteCallback](SetCompleteCallback.md) | 设置相关状态或配置。 |
|
||||
| [IsComplete](IsComplete.md) | 查询当前状态。 |
|
||||
| [GetProgress](GetProgress.md) | 获取相关状态或对象。 |
|
||||
| [Cancel](Cancel.md) | 判断当前条件下是否可执行。 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Threading.md) - 返回 `Threading` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
Reference in New Issue
Block a user