refactor api documentation structure

docs/api/XCEngine/Debug/RenderDocCapture/BeginCapture.md

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

docs/api/XCEngine/Debug/RenderDocCapture/EndCapture.md

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

docs/api/XCEngine/Debug/RenderDocCapture/Get.md

@@ -0,0 +1,29 @@
+# RenderDocCapture::Get
+
+获取相关状态或对象。
+
+```cpp
+static RenderDocCapture& Get();
+```
+
+该方法声明于 `XCEngine/Debug/RenderDocCapture.h`，当前页面用于固定 `RenderDocCapture` 类目录下的方法级 canonical 路径。
+
+**参数：** 无。
+
+**返回：** `RenderDocCapture&` - 返回值语义详见头文件声明。
+
+**示例：**
+
+```cpp
+#include <XCEngine/Debug/RenderDocCapture.h>
+
+void Example() {
+    auto& instance = XCEngine::Debug::RenderDocCapture::Get();
+    (void)instance;
+}
+```
+
+## 相关文档
+
+- [返回类总览](RenderDocCapture.md)
+- [返回模块目录](../Debug.md)

docs/api/XCEngine/Debug/RenderDocCapture/GetCapture.md

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

docs/api/XCEngine/Debug/RenderDocCapture/GetNumCaptures.md

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

docs/api/XCEngine/Debug/RenderDocCapture/Initialize.md

@@ -0,0 +1,32 @@
+# RenderDocCapture::Initialize
+
+初始化内部状态。
+
+```cpp
+bool Initialize(void* device = nullptr, void* window = nullptr);
+```
+
+该方法声明于 `XCEngine/Debug/RenderDocCapture.h`，当前页面用于固定 `RenderDocCapture` 类目录下的方法级 canonical 路径。
+
+**参数：**
+- `device` - 参数语义详见头文件声明。
+- `window` - 参数语义详见头文件声明。
+
+**返回：** `bool` - 返回值语义详见头文件声明。
+
+**示例：**
+
+```cpp
+#include <XCEngine/Debug/RenderDocCapture.h>
+
+void Example() {
+    XCEngine::Debug::RenderDocCapture object;
+    // 根据上下文补齐参数后调用 RenderDocCapture::Initialize(...)。
+    (void)object;
+}
+```
+
+## 相关文档
+
+- [返回类总览](RenderDocCapture.md)
+- [返回模块目录](../Debug.md)

docs/api/XCEngine/Debug/RenderDocCapture/IsCapturing.md

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

docs/api/XCEngine/Debug/RenderDocCapture/IsLoaded.md

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

docs/api/XCEngine/Debug/RenderDocCapture/LaunchReplayUI.md

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

docs/api/XCEngine/Debug/RenderDocCapture/RenderDocCapture.md

@@ -0,0 +1,46 @@
+# RenderDocCapture
+
+**命名空间**: `XCEngine::Debug`
+
+**类型**: `class (singleton)`
+
+**头文件**: `XCEngine/Debug/RenderDocCapture.h`
+
+**描述**: 定义 `XCEngine/Debug` 子目录中的 `RenderDocCapture` public API。
+
+## 概述
+
+`RenderDocCapture.h` 是 `XCEngine/Debug` 子目录 下的 public header，当前页面作为平行目录中的 canonical 总览，用于汇总该头文件暴露的主要声明。
+
+## 声明概览
+
+| 声明 | 类型 | 说明 |
+|------|------|------|
+| `RenderDocCaptureInfo` | `struct` | 头文件中的公开声明。 |
+| `RenderDocCapture` | `class` | 头文件中的公开声明。 |
+
+## 公共方法
+
+| 方法 | 描述 |
+|------|------|
+| [Get](Get.md) | 获取相关状态或对象。 |
+| [Initialize](Initialize.md) | 初始化内部状态。 |
+| [Shutdown](Shutdown.md) | 关闭并清理内部状态。 |
+| [SetDevice](SetDevice.md) | 设置相关状态或配置。 |
+| [SetWindow](SetWindow.md) | 设置相关状态或配置。 |
+| [IsLoaded](IsLoaded.md) | 查询当前状态。 |
+| [IsCapturing](IsCapturing.md) | 查询当前状态。 |
+| [GetNumCaptures](GetNumCaptures.md) | 获取相关状态或对象。 |
+| [GetCapture](GetCapture.md) | 获取相关状态或对象。 |
+| [BeginCapture](BeginCapture.md) | 公开方法，详见头文件声明。 |
+| [EndCapture](EndCapture.md) | 公开方法，详见头文件声明。 |
+| [TriggerCapture](TriggerCapture.md) | 公开方法，详见头文件声明。 |
+| [SetCaptureFilePath](SetCaptureFilePath.md) | 设置相关状态或配置。 |
+| [SetCaptureComments](SetCaptureComments.md) | 设置相关状态或配置。 |
+| [SetCaptureOptionU32](SetCaptureOptionU32.md) | 设置相关状态或配置。 |
+| [LaunchReplayUI](LaunchReplayUI.md) | 公开方法，详见头文件声明。 |
+
+## 相关文档
+
+- [当前目录](../Debug.md) - 返回 `Debug` 平行目录
+- [API 总索引](../../../main.md) - 返回顶层索引

docs/api/XCEngine/Debug/RenderDocCapture/SetCaptureComments.md

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

docs/api/XCEngine/Debug/RenderDocCapture/SetCaptureFilePath.md

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

docs/api/XCEngine/Debug/RenderDocCapture/SetCaptureOptionU32.md

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

docs/api/XCEngine/Debug/RenderDocCapture/SetDevice.md

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

docs/api/XCEngine/Debug/RenderDocCapture/SetWindow.md

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

docs/api/XCEngine/Debug/RenderDocCapture/Shutdown.md

@@ -0,0 +1,30 @@
+# RenderDocCapture::Shutdown
+
+关闭并清理内部状态。
+
+```cpp
+void Shutdown();
+```
+
+该方法声明于 `XCEngine/Debug/RenderDocCapture.h`，当前页面用于固定 `RenderDocCapture` 类目录下的方法级 canonical 路径。
+
+**参数：** 无。
+
+**返回：** `void` - 无返回值。
+
+**示例：**
+
+```cpp
+#include <XCEngine/Debug/RenderDocCapture.h>
+
+void Example() {
+    XCEngine::Debug::RenderDocCapture object;
+    // 根据上下文补齐参数后调用 RenderDocCapture::Shutdown(...)。
+    (void)object;
+}
+```
+
+## 相关文档
+
+- [返回类总览](RenderDocCapture.md)
+- [返回模块目录](../Debug.md)

docs/api/XCEngine/Debug/RenderDocCapture/TriggerCapture.md

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