refactor api documentation structure

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

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

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

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

docs/api/XCEngine/Core/Containers/HashMap/Contains.md

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

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

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

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

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

docs/api/XCEngine/Core/Containers/HashMap/Erase.md

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

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

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

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

@@ -0,0 +1,43 @@
+# HashMap
+
+**命名空间**: `XCEngine::Containers`
+
+**类型**: `class`
+
+**头文件**: `XCEngine/Core/Containers/HashMap.h`
+
+**描述**: 定义 `XCEngine/Core/Containers` 子目录中的 `HashMap` public API。
+
+## 概述
+
+`HashMap.h` 是 `XCEngine/Core/Containers` 子目录 下的 public header，当前页面作为平行目录中的 canonical 总览，用于汇总该头文件暴露的主要声明。
+
+## 声明概览
+
+| 声明 | 类型 | 说明 |
+|------|------|------|
+| `HashMap` | `class` | 头文件中的公开声明。 |
+
+## 公共方法
+
+| 方法 | 描述 |
+|------|------|
+| [HashMap()](Constructor.md) | 构造对象。 |
+| [~HashMap()](Destructor.md) | 销毁对象并释放相关资源。 |
+| [operator=](OperatorAssign.md) | 公开方法，详见头文件声明。 |
+| [operator[]](OperatorSubscript.md) | 公开方法，详见头文件声明。 |
+| [Find](Find.md) | 查找并返回匹配对象。 |
+| [Contains](Contains.md) | 公开方法，详见头文件声明。 |
+| [Insert](Insert.md) | 公开方法，详见头文件声明。 |
+| [Erase](Erase.md) | 公开方法，详见头文件声明。 |
+| [Clear](Clear.md) | 清空内部数据。 |
+| [Size](Size.md) | 公开方法，详见头文件声明。 |
+| [Empty](Empty.md) | 公开方法，详见头文件声明。 |
+| [begin](begin.md) | 公开方法，详见头文件声明。 |
+| [end](end.md) | 公开方法，详见头文件声明。 |
+| [SetAllocator](SetAllocator.md) | 设置相关状态或配置。 |
+
+## 相关文档
+
+- [当前目录](../Containers.md) - 返回 `Containers` 平行目录
+- [API 总索引](../../../../main.md) - 返回顶层索引

docs/api/XCEngine/Core/Containers/HashMap/Insert.md

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

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

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

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

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

docs/api/XCEngine/Core/Containers/HashMap/SetAllocator.md

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

docs/api/XCEngine/Core/Containers/HashMap/Size.md

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

docs/api/XCEngine/Core/Containers/HashMap/begin.md

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

docs/api/XCEngine/Core/Containers/HashMap/end.md

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