docs: rebuild Threading API content
This commit is contained in:
@@ -1,30 +1,20 @@
|
||||
# Thread::Join
|
||||
|
||||
公开方法,详见头文件声明。
|
||||
等待线程结束。
|
||||
|
||||
```cpp
|
||||
void Join();
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Threading/Thread.h`,当前页面用于固定 `Thread` 类目录下的方法级 canonical 路径。
|
||||
## 行为说明
|
||||
|
||||
**参数:** 无。
|
||||
当前实现会在 `m_thread.joinable()` 时调用 `m_thread.join()`;否则什么也不做。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
## 返回值
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Threading/Thread.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Threading::Thread object;
|
||||
// 根据上下文补齐参数后调用 Thread::Join(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 无。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](Thread.md)
|
||||
- [返回模块目录](../Threading.md)
|
||||
- [返回类型总览](Thread.md)
|
||||
- [Detach](Detach.md)
|
||||
|
||||
Reference in New Issue
Block a user