refactor api documentation structure
This commit is contained in:
29
docs/api/XCEngine/Threading/TaskSystem/Get.md
Normal file
29
docs/api/XCEngine/Threading/TaskSystem/Get.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# TaskSystem::Get
|
||||
|
||||
获取相关状态或对象。
|
||||
|
||||
```cpp
|
||||
static TaskSystem& Get();
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Threading/TaskSystem.h`,当前页面用于固定 `TaskSystem` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `TaskSystem&` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Threading/TaskSystem.h>
|
||||
|
||||
void Example() {
|
||||
auto& instance = XCEngine::Threading::TaskSystem::Get();
|
||||
(void)instance;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](TaskSystem.md)
|
||||
- [返回模块目录](../Threading.md)
|
||||
Reference in New Issue
Block a user