refactor api documentation structure

docs/api/XCEngine/Core/Containers/String/CStr.md

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

docs/api/XCEngine/Core/Containers/String/Capacity.md

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

docs/api/XCEngine/Core/Containers/String/Clear.md

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

docs/api/XCEngine/Core/Containers/String/Constructor.md

@@ -0,0 +1,75 @@
+# String::String()
+
+构造对象。
+
+该方法在 `XCEngine/Core/Containers/String.h` 中提供了 5 个重载，当前页面统一汇总这些公开声明。
+
+## 重载 1: 声明
+
+```cpp
+String();
+```
+
+**参数：** 无。
+
+**返回：** `void` - 无返回值。
+
+## 重载 2: 声明
+
+```cpp
+String(const char* str);
+```
+
+**参数：**
+- `str` - 参数语义详见头文件声明。
+
+**返回：** `void` - 无返回值。
+
+## 重载 3: 声明
+
+```cpp
+String(const char* str, SizeType len);
+```
+
+**参数：**
+- `str` - 参数语义详见头文件声明。
+- `len` - 参数语义详见头文件声明。
+
+**返回：** `void` - 无返回值。
+
+## 重载 4: 声明
+
+```cpp
+String(const String& other);
+```
+
+**参数：**
+- `other` - 参数语义详见头文件声明。
+
+**返回：** `void` - 无返回值。
+
+## 重载 5: 声明
+
+```cpp
+String(String&& other) noexcept;
+```
+
+**参数：**
+- `other` - 参数语义详见头文件声明。
+
+**返回：** `void` - 无返回值。
+
+**示例：**
+
+```cpp
+#include <XCEngine/Core/Containers/String.h>
+
+void Example() {
+    XCEngine::Containers::String object;
+}
+```
+
+## 相关文档
+
+- [返回类总览](String.md)
+- [返回模块目录](../Containers.md)

docs/api/XCEngine/Core/Containers/String/Destructor.md

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

docs/api/XCEngine/Core/Containers/String/Empty.md

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

docs/api/XCEngine/Core/Containers/String/EndsWith.md

@@ -0,0 +1,44 @@
+# String::EndsWith
+
+公开方法，详见头文件声明。
+
+该方法在 `XCEngine/Core/Containers/String.h` 中提供了 2 个重载，当前页面统一汇总这些公开声明。
+
+## 重载 1: 声明
+
+```cpp
+bool EndsWith(const String& suffix) const;
+```
+
+**参数：**
+- `suffix` - 参数语义详见头文件声明。
+
+**返回：** `bool` - 返回值语义详见头文件声明。
+
+## 重载 2: 声明
+
+```cpp
+bool EndsWith(const char* suffix) const;
+```
+
+**参数：**
+- `suffix` - 参数语义详见头文件声明。
+
+**返回：** `bool` - 返回值语义详见头文件声明。
+
+**示例：**
+
+```cpp
+#include <XCEngine/Core/Containers/String.h>
+
+void Example() {
+    XCEngine::Containers::String object;
+    // 根据上下文补齐参数后调用 String::EndsWith(...)。
+    (void)object;
+}
+```
+
+## 相关文档
+
+- [返回类总览](String.md)
+- [返回模块目录](../Containers.md)

docs/api/XCEngine/Core/Containers/String/Find.md

@@ -0,0 +1,32 @@
+# String::Find
+
+查找并返回匹配对象。
+
+```cpp
+SizeType Find(const char* str, SizeType pos = 0) const;
+```
+
+该方法声明于 `XCEngine/Core/Containers/String.h`，当前页面用于固定 `String` 类目录下的方法级 canonical 路径。
+
+**参数：**
+- `str` - 参数语义详见头文件声明。
+- `pos` - 参数语义详见头文件声明。
+
+**返回：** `SizeType` - 返回值语义详见头文件声明。
+
+**示例：**
+
+```cpp
+#include <XCEngine/Core/Containers/String.h>
+
+void Example() {
+    XCEngine::Containers::String object;
+    // 根据上下文补齐参数后调用 String::Find(...)。
+    (void)object;
+}
+```
+
+## 相关文档
+
+- [返回类总览](String.md)
+- [返回模块目录](../Containers.md)

docs/api/XCEngine/Core/Containers/String/Length.md

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

docs/api/XCEngine/Core/Containers/String/OperatorAssign.md

@@ -0,0 +1,55 @@
+# String::operator=
+
+公开方法，详见头文件声明。
+
+该方法在 `XCEngine/Core/Containers/String.h` 中提供了 3 个重载，当前页面统一汇总这些公开声明。
+
+## 重载 1: 声明
+
+```cpp
+String& operator=(const String& other);
+```
+
+**参数：**
+- `other` - 参数语义详见头文件声明。
+
+**返回：** `String&` - 返回值语义详见头文件声明。
+
+## 重载 2: 声明
+
+```cpp
+String& operator=(String&& other) noexcept;
+```
+
+**参数：**
+- `other` - 参数语义详见头文件声明。
+
+**返回：** `String&` - 返回值语义详见头文件声明。
+
+## 重载 3: 声明
+
+```cpp
+String& operator=(const char* str);
+```
+
+**参数：**
+- `str` - 参数语义详见头文件声明。
+
+**返回：** `String&` - 返回值语义详见头文件声明。
+
+**示例：**
+
+```cpp
+#include <XCEngine/Core/Containers/String.h>
+
+void Example() {
+    XCEngine::Containers::String object;
+    // 根据上下文补齐参数后调用 String::operator=(...)。
+    (void)object;
+}
+```
+
+## 相关文档
+
+- [返回类总览](String.md)
+- [返回模块目录](../Containers.md)

docs/api/XCEngine/Core/Containers/String/OperatorPlusAssign.md

@@ -0,0 +1,55 @@
+# String::operator+=
+
+公开方法，详见头文件声明。
+
+该方法在 `XCEngine/Core/Containers/String.h` 中提供了 3 个重载，当前页面统一汇总这些公开声明。
+
+## 重载 1: 声明
+
+```cpp
+String& operator+=(const String& other);
+```
+
+**参数：**
+- `other` - 参数语义详见头文件声明。
+
+**返回：** `String&` - 返回值语义详见头文件声明。
+
+## 重载 2: 声明
+
+```cpp
+String& operator+=(const char* str);
+```
+
+**参数：**
+- `str` - 参数语义详见头文件声明。
+
+**返回：** `String&` - 返回值语义详见头文件声明。
+
+## 重载 3: 声明
+
+```cpp
+String& operator+=(char c);
+```
+
+**参数：**
+- `c` - 参数语义详见头文件声明。
+
+**返回：** `String&` - 返回值语义详见头文件声明。
+
+**示例：**
+
+```cpp
+#include <XCEngine/Core/Containers/String.h>
+
+void Example() {
+    XCEngine::Containers::String object;
+    // 根据上下文补齐参数后调用 String::operator+=(...)。
+    (void)object;
+}
+```
+
+## 相关文档
+
+- [返回类总览](String.md)
+- [返回模块目录](../Containers.md)

docs/api/XCEngine/Core/Containers/String/OperatorSubscript.md

@@ -0,0 +1,44 @@
+# String::operator[]
+
+公开方法，详见头文件声明。
+
+该方法在 `XCEngine/Core/Containers/String.h` 中提供了 2 个重载，当前页面统一汇总这些公开声明。
+
+## 重载 1: 声明
+
+```cpp
+char& operator[](SizeType index);
+```
+
+**参数：**
+- `index` - 参数语义详见头文件声明。
+
+**返回：** `char&` - 返回值语义详见头文件声明。
+
+## 重载 2: 声明
+
+```cpp
+const char& operator[](SizeType index) const;
+```
+
+**参数：**
+- `index` - 参数语义详见头文件声明。
+
+**返回：** `const char&` - 返回值语义详见头文件声明。
+
+**示例：**
+
+```cpp
+#include <XCEngine/Core/Containers/String.h>
+
+void Example() {
+    XCEngine::Containers::String object;
+    // 根据上下文补齐参数后调用 String::operator[](...)。
+    (void)object;
+}
+```
+
+## 相关文档
+
+- [返回类总览](String.md)
+- [返回模块目录](../Containers.md)

docs/api/XCEngine/Core/Containers/String/Reserve.md

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

docs/api/XCEngine/Core/Containers/String/Resize.md

@@ -0,0 +1,45 @@
+# String::Resize
+
+公开方法，详见头文件声明。
+
+该方法在 `XCEngine/Core/Containers/String.h` 中提供了 2 个重载，当前页面统一汇总这些公开声明。
+
+## 重载 1: 声明
+
+```cpp
+void Resize(SizeType newSize);
+```
+
+**参数：**
+- `newSize` - 参数语义详见头文件声明。
+
+**返回：** `void` - 无返回值。
+
+## 重载 2: 声明
+
+```cpp
+void Resize(SizeType newSize, char fillChar);
+```
+
+**参数：**
+- `newSize` - 参数语义详见头文件声明。
+- `fillChar` - 参数语义详见头文件声明。
+
+**返回：** `void` - 无返回值。
+
+**示例：**
+
+```cpp
+#include <XCEngine/Core/Containers/String.h>
+
+void Example() {
+    XCEngine::Containers::String object;
+    // 根据上下文补齐参数后调用 String::Resize(...)。
+    (void)object;
+}
+```
+
+## 相关文档
+
+- [返回类总览](String.md)
+- [返回模块目录](../Containers.md)

docs/api/XCEngine/Core/Containers/String/StartsWith.md

@@ -0,0 +1,44 @@
+# String::StartsWith
+
+公开方法，详见头文件声明。
+
+该方法在 `XCEngine/Core/Containers/String.h` 中提供了 2 个重载，当前页面统一汇总这些公开声明。
+
+## 重载 1: 声明
+
+```cpp
+bool StartsWith(const String& prefix) const;
+```
+
+**参数：**
+- `prefix` - 参数语义详见头文件声明。
+
+**返回：** `bool` - 返回值语义详见头文件声明。
+
+## 重载 2: 声明
+
+```cpp
+bool StartsWith(const char* prefix) const;
+```
+
+**参数：**
+- `prefix` - 参数语义详见头文件声明。
+
+**返回：** `bool` - 返回值语义详见头文件声明。
+
+**示例：**
+
+```cpp
+#include <XCEngine/Core/Containers/String.h>
+
+void Example() {
+    XCEngine::Containers::String object;
+    // 根据上下文补齐参数后调用 String::StartsWith(...)。
+    (void)object;
+}
+```
+
+## 相关文档
+
+- [返回类总览](String.md)
+- [返回模块目录](../Containers.md)

docs/api/XCEngine/Core/Containers/String/String.md

@@ -0,0 +1,58 @@
+# String
+
+**命名空间**: `XCEngine::Containers`
+
+**类型**: `class`
+
+**头文件**: `XCEngine/Core/Containers/String.h`
+
+**描述**: 定义 `XCEngine/Core/Containers` 子目录中的 `String` public API。
+
+## 概述
+
+`String.h` 是 `XCEngine/Core/Containers` 子目录 下的 public header，当前页面作为平行目录中的 canonical 总览，用于汇总该头文件暴露的主要声明。
+
+## 声明概览
+
+| 声明 | 类型 | 说明 |
+|------|------|------|
+| `String` | `class` | 头文件中的公开声明。 |
+
+## 公共方法
+
+| 方法 | 描述 |
+|------|------|
+| [String()](Constructor.md) | 构造对象。 |
+| [~String()](Destructor.md) | 销毁对象并释放相关资源。 |
+| [operator=](OperatorAssign.md) | 公开方法，详见头文件声明。 |
+| [operator+=](OperatorPlusAssign.md) | 公开方法，详见头文件声明。 |
+| [Substring](Substring.md) | 公开方法，详见头文件声明。 |
+| [Trim](Trim.md) | 公开方法，详见头文件声明。 |
+| [ToLower](ToLower.md) | 公开方法，详见头文件声明。 |
+| [ToUpper](ToUpper.md) | 公开方法，详见头文件声明。 |
+| [Find](Find.md) | 查找并返回匹配对象。 |
+| [StartsWith](StartsWith.md) | 公开方法，详见头文件声明。 |
+| [EndsWith](EndsWith.md) | 公开方法，详见头文件声明。 |
+| [CStr](CStr.md) | 公开方法，详见头文件声明。 |
+| [Length](Length.md) | 公开方法，详见头文件声明。 |
+| [Capacity](Capacity.md) | 公开方法，详见头文件声明。 |
+| [Empty](Empty.md) | 公开方法，详见头文件声明。 |
+| [operator[]](OperatorSubscript.md) | 公开方法，详见头文件声明。 |
+| [Clear](Clear.md) | 清空内部数据。 |
+| [Reserve](Reserve.md) | 公开方法，详见头文件声明。 |
+| [Resize](Resize.md) | 公开方法，详见头文件声明。 |
+
+## std::hash 特化
+
+```cpp
+namespace std {
+    template<> struct hash<XCEngine::Containers::String>;
+}
+```
+
+`String.h` 同时提供 `std::hash<XCEngine::Containers::String>` 特化，可直接用于哈希容器键类型。
+
+## 相关文档
+
+- [当前目录](../Containers.md) - 返回 `Containers` 平行目录
+- [API 总索引](../../../../main.md) - 返回顶层索引

docs/api/XCEngine/Core/Containers/String/Substring.md

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

docs/api/XCEngine/Core/Containers/String/ToLower.md

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

docs/api/XCEngine/Core/Containers/String/ToUpper.md

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

docs/api/XCEngine/Core/Containers/String/Trim.md

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