refactor api documentation structure
This commit is contained in:
36
docs/api/XCEngine/Threading/Task/Task.md
Normal file
36
docs/api/XCEngine/Threading/Task/Task.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# Task
|
||||
|
||||
**命名空间**: `XCEngine::Threading`
|
||||
|
||||
**类型**: `enum class`
|
||||
|
||||
**头文件**: `XCEngine/Threading/Task.h`
|
||||
|
||||
**描述**: 定义 `XCEngine/Threading` 子目录中的 `Task` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`Task.h` 是 `XCEngine/Threading` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `TaskPriority` | `enum class` | 头文件中的公开声明。 |
|
||||
| `TaskStatus` | `enum class` | 头文件中的公开声明。 |
|
||||
| `ITask` | `class` | 头文件中的公开声明。 |
|
||||
|
||||
## 枚举值
|
||||
|
||||
| 枚举值 | 数值 | 描述 |
|
||||
|--------|------|------|
|
||||
| `Critical` | `0` | 枚举项。 |
|
||||
| `High` | `1` | 枚举项。 |
|
||||
| `Normal` | `2` | 枚举项。 |
|
||||
| `Low` | `3` | 枚举项。 |
|
||||
| `Idle` | `4` | 枚举项。 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Threading.md) - 返回 `Threading` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
Reference in New Issue
Block a user