refactor api documentation structure

docs/api/XCEngine/Threading/Thread/Constructor.md

@@ -0,0 +1,28 @@
+# Thread::Thread()
+
+构造对象。
+
+```cpp
+Thread();
+```
+
+该方法声明于 `XCEngine/Threading/Thread.h`，当前页面用于固定 `Thread` 类目录下的方法级 canonical 路径。
+
+**参数：** 无。
+
+**返回：** `void` - 无返回值。
+
+**示例：**
+
+```cpp
+#include <XCEngine/Threading/Thread.h>
+
+void Example() {
+    XCEngine::Threading::Thread object;
+}
+```
+
+## 相关文档
+
+- [返回类总览](Thread.md)
+- [返回模块目录](../Threading.md)

docs/api/XCEngine/Threading/Thread/Destructor.md

@@ -0,0 +1,29 @@
+# Thread::~Thread()
+
+销毁对象并释放相关资源。
+
+```cpp
+~Thread();
+```
+
+该方法声明于 `XCEngine/Threading/Thread.h`，当前页面用于固定 `Thread` 类目录下的方法级 canonical 路径。
+
+**参数：** 无。
+
+**返回：** `void` - 无返回值。
+
+**示例：**
+
+```cpp
+#include <XCEngine/Threading/Thread.h>
+
+void Example() {
+    XCEngine::Threading::Thread object;
+    // 对象离开作用域时会自动触发析构。
+}
+```
+
+## 相关文档
+
+- [返回类总览](Thread.md)
+- [返回模块目录](../Threading.md)

docs/api/XCEngine/Threading/Thread/Detach.md

@@ -0,0 +1,30 @@
+# Thread::Detach
+
+公开方法，详见头文件声明。
+
+```cpp
+void Detach();
+```
+
+该方法声明于 `XCEngine/Threading/Thread.h`，当前页面用于固定 `Thread` 类目录下的方法级 canonical 路径。
+
+**参数：** 无。
+
+**返回：** `void` - 无返回值。
+
+**示例：**
+
+```cpp
+#include <XCEngine/Threading/Thread.h>
+
+void Example() {
+    XCEngine::Threading::Thread object;
+    // 根据上下文补齐参数后调用 Thread::Detach(...)。
+    (void)object;
+}
+```
+
+## 相关文档
+
+- [返回类总览](Thread.md)
+- [返回模块目录](../Threading.md)

docs/api/XCEngine/Threading/Thread/GetCurrentId.md

@@ -0,0 +1,30 @@
+# Thread::GetCurrentId
+
+获取相关状态或对象。
+
+```cpp
+static Id GetCurrentId();
+```
+
+该方法声明于 `XCEngine/Threading/Thread.h`，当前页面用于固定 `Thread` 类目录下的方法级 canonical 路径。
+
+**参数：** 无。
+
+**返回：** `Id` - 返回值语义详见头文件声明。
+
+**示例：**
+
+```cpp
+#include <XCEngine/Threading/Thread.h>
+
+void Example() {
+    XCEngine::Threading::Thread object;
+    // 根据上下文补齐参数后调用 Thread::GetCurrentId(...)。
+    (void)object;
+}
+```
+
+## 相关文档
+
+- [返回类总览](Thread.md)
+- [返回模块目录](../Threading.md)

docs/api/XCEngine/Threading/Thread/GetId.md

@@ -0,0 +1,30 @@
+# Thread::GetId
+
+获取相关状态或对象。
+
+```cpp
+Id GetId() const;
+```
+
+该方法声明于 `XCEngine/Threading/Thread.h`，当前页面用于固定 `Thread` 类目录下的方法级 canonical 路径。
+
+**参数：** 无。
+
+**返回：** `Id` - 返回值语义详见头文件声明。
+
+**示例：**
+
+```cpp
+#include <XCEngine/Threading/Thread.h>
+
+void Example() {
+    XCEngine::Threading::Thread object;
+    // 根据上下文补齐参数后调用 Thread::GetId(...)。
+    (void)object;
+}
+```
+
+## 相关文档
+
+- [返回类总览](Thread.md)
+- [返回模块目录](../Threading.md)

docs/api/XCEngine/Threading/Thread/GetName.md

@@ -0,0 +1,30 @@
+# Thread::GetName
+
+获取相关状态或对象。
+
+```cpp
+const Containers::String& GetName() const;
+```
+
+该方法声明于 `XCEngine/Threading/Thread.h`，当前页面用于固定 `Thread` 类目录下的方法级 canonical 路径。
+
+**参数：** 无。
+
+**返回：** `const Containers::String&` - 返回值语义详见头文件声明。
+
+**示例：**
+
+```cpp
+#include <XCEngine/Threading/Thread.h>
+
+void Example() {
+    XCEngine::Threading::Thread object;
+    // 根据上下文补齐参数后调用 Thread::GetName(...)。
+    (void)object;
+}
+```
+
+## 相关文档
+
+- [返回类总览](Thread.md)
+- [返回模块目录](../Threading.md)

docs/api/XCEngine/Threading/Thread/Join.md

@@ -0,0 +1,30 @@
+# Thread::Join
+
+公开方法，详见头文件声明。
+
+```cpp
+void Join();
+```
+
+该方法声明于 `XCEngine/Threading/Thread.h`，当前页面用于固定 `Thread` 类目录下的方法级 canonical 路径。
+
+**参数：** 无。
+
+**返回：** `void` - 无返回值。
+
+**示例：**
+
+```cpp
+#include <XCEngine/Threading/Thread.h>
+
+void Example() {
+    XCEngine::Threading::Thread object;
+    // 根据上下文补齐参数后调用 Thread::Join(...)。
+    (void)object;
+}
+```
+
+## 相关文档
+
+- [返回类总览](Thread.md)
+- [返回模块目录](../Threading.md)

docs/api/XCEngine/Threading/Thread/Sleep.md

@@ -0,0 +1,31 @@
+# Thread::Sleep
+
+公开方法，详见头文件声明。
+
+```cpp
+static void Sleep(uint32_t milliseconds);
+```
+
+该方法声明于 `XCEngine/Threading/Thread.h`，当前页面用于固定 `Thread` 类目录下的方法级 canonical 路径。
+
+**参数：**
+- `milliseconds` - 参数语义详见头文件声明。
+
+**返回：** `void` - 无返回值。
+
+**示例：**
+
+```cpp
+#include <XCEngine/Threading/Thread.h>
+
+void Example() {
+    XCEngine::Threading::Thread object;
+    // 根据上下文补齐参数后调用 Thread::Sleep(...)。
+    (void)object;
+}
+```
+
+## 相关文档
+
+- [返回类总览](Thread.md)
+- [返回模块目录](../Threading.md)

docs/api/XCEngine/Threading/Thread/Start.md

@@ -0,0 +1,32 @@
+# Thread::Start
+
+公开方法，详见头文件声明。
+
+```cpp
+template<typename Func> void Start(Func&& func, const Containers::String& name = "Thread");
+```
+
+该方法声明于 `XCEngine/Threading/Thread.h`，当前页面用于固定 `Thread` 类目录下的方法级 canonical 路径。
+
+**参数：**
+- `func` - 参数语义详见头文件声明。
+- `name` - 参数语义详见头文件声明。
+
+**返回：** `template<typename Func> void` - 返回值语义详见头文件声明。
+
+**示例：**
+
+```cpp
+#include <XCEngine/Threading/Thread.h>
+
+void Example() {
+    XCEngine::Threading::Thread object;
+    // 根据上下文补齐参数后调用 Thread::Start(...)。
+    (void)object;
+}
+```
+
+## 相关文档
+
+- [返回类总览](Thread.md)
+- [返回模块目录](../Threading.md)

docs/api/XCEngine/Threading/Thread/Thread.md

@@ -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) - 返回顶层索引

docs/api/XCEngine/Threading/Thread/Yield.md

@@ -0,0 +1,30 @@
+# Thread::Yield
+
+公开方法，详见头文件声明。
+
+```cpp
+static void Yield();
+```
+
+该方法声明于 `XCEngine/Threading/Thread.h`，当前页面用于固定 `Thread` 类目录下的方法级 canonical 路径。
+
+**参数：** 无。
+
+**返回：** `void` - 无返回值。
+
+**示例：**
+
+```cpp
+#include <XCEngine/Threading/Thread.h>
+
+void Example() {
+    XCEngine::Threading::Thread object;
+    // 根据上下文补齐参数后调用 Thread::Yield(...)。
+    (void)object;
+}
+```
+
+## 相关文档
+
+- [返回类总览](Thread.md)
+- [返回模块目录](../Threading.md)