refactor api documentation structure
This commit is contained in:
39
docs/api/XCEngine/Threading/Thread/Thread.md
Normal file
39
docs/api/XCEngine/Threading/Thread/Thread.md
Normal file
@@ -0,0 +1,39 @@
|
||||
# Thread
|
||||
|
||||
**命名空间**: `XCEngine::Threading`
|
||||
|
||||
**类型**: `class`
|
||||
|
||||
**头文件**: `XCEngine/Threading/Thread.h`
|
||||
|
||||
**描述**: 定义 `XCEngine/Threading` 子目录中的 `Thread` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`Thread.h` 是 `XCEngine/Threading` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `Thread` | `class` | 头文件中的公开声明。 |
|
||||
|
||||
## 公共方法
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [Thread()](Constructor.md) | 构造对象。 |
|
||||
| [~Thread()](Destructor.md) | 销毁对象并释放相关资源。 |
|
||||
| [Start](Start.md) | 公开方法,详见头文件声明。 |
|
||||
| [Join](Join.md) | 公开方法,详见头文件声明。 |
|
||||
| [Detach](Detach.md) | 公开方法,详见头文件声明。 |
|
||||
| [GetId](GetId.md) | 获取相关状态或对象。 |
|
||||
| [GetName](GetName.md) | 获取相关状态或对象。 |
|
||||
| [GetCurrentId](GetCurrentId.md) | 获取相关状态或对象。 |
|
||||
| [Sleep](Sleep.md) | 公开方法,详见头文件声明。 |
|
||||
| [Yield](Yield.md) | 公开方法,详见头文件声明。 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Threading.md) - 返回 `Threading` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
Reference in New Issue
Block a user