xuanchi/XCEngine
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: sync api and planning docs

Browse Source
This commit is contained in:
ssdfasd
2026-04-08 16:07:03 +08:00
parent 08c3278e10
commit 31756847ab
1826 changed files with 44502 additions and 29645 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
docs/api/XCEngine/Core/Containers/HashMap/Clear.md
View File

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

58
docs/api/XCEngine/Core/Containers/HashMap/Constructor.md
View File

@@ -1,64 +1,30 @@
# HashMap::HashMap()
构造对象。
**命名空间**: `XCEngine::Containers`
该方法在 `XCEngine/Core/Containers/HashMap.h` 中提供了 4 个重载，当前页面统一汇总这些公开声明。
**类型**: `method`
## 重载 1: 声明
**头文件**: `XCEngine/Core/Containers/HashMap.h`
## 签名
```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` - 无返回值。
更新 `m_buckets`。
**示例：**
## 当前实现
```cpp
#include <XCEngine/Core/Containers/HashMap.h>
void Example() {
XCEngine::Containers::HashMap object;
}
```
- 会更新 `m_buckets`。
- 当前实现会调用 `Resize`。
- 当前实现会调用 `Clear`。
## 相关文档
- [返回类总览](HashMap.md)
- [返回模块目录](../Containers.md)
- [HashMap](HashMap.md)

30
docs/api/XCEngine/Core/Containers/HashMap/Contains.md
View File

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

28
docs/api/XCEngine/Core/Containers/HashMap/Destructor.md
View File

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

29
docs/api/XCEngine/Core/Containers/HashMap/Empty.md
View File

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

30
docs/api/XCEngine/Core/Containers/HashMap/Erase.md
View File

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

38
docs/api/XCEngine/Core/Containers/HashMap/Find.md
View File

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

50
docs/api/XCEngine/Core/Containers/HashMap/Insert.md
View File

@@ -1,57 +1,27 @@
# HashMap::Insert
公开方法，详见头文件声明。
**命名空间**: `XCEngine::Containers`
该方法在 `XCEngine/Core/Containers/HashMap.h` 中提供了 3 个重载，当前页面统一汇总这些公开声明。
**类型**: `method`
## 重载 1: 声明
**头文件**: `XCEngine/Core/Containers/HashMap.h`
## 签名
```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` - 返回值语义详见头文件声明。
执行 `Insert` 对应的公开操作。
**示例：**
## 当前实现
```cpp
#include <XCEngine/Core/Containers/HashMap.h>
void Example() {
XCEngine::Containers::HashMap object;
// 根据上下文补齐参数后调用 HashMap::Insert(...)。
(void)object;
}
```
- 执行 `Insert` 对应的公开操作。
## 相关文档
- [返回类总览](HashMap.md)
- [返回模块目录](../Containers.md)
- [HashMap](HashMap.md)

38
docs/api/XCEngine/Core/Containers/HashMap/OperatorAssign.md
View File

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

30
docs/api/XCEngine/Core/Containers/HashMap/OperatorSubscript.md
View File

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

30
docs/api/XCEngine/Core/Containers/HashMap/SetAllocator.md
View File

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

29
docs/api/XCEngine/Core/Containers/HashMap/Size.md
View File

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

36
docs/api/XCEngine/Core/Containers/HashMap/begin.md
View File

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

39
docs/api/XCEngine/Core/Containers/HashMap/end.md
View File

@@ -1,42 +1,29 @@
# HashMap::end
公开方法，详见头文件声明。
**命名空间**: `XCEngine::Containers`
该方法在 `XCEngine/Core/Containers/HashMap.h` 中提供了 2 个重载，当前页面统一汇总这些公开声明。
**类型**: `method`
## 重载 1: 声明
**头文件**: `XCEngine/Core/Containers/HashMap.h`
## 签名
```cpp
Iterator end();
```
**参数：** 无。
**返回：** `Iterator` - 返回值语义详见头文件声明。
## 重载 2: 声明
```cpp
ConstIterator end() const;
```
**参数：** 无。
## 作用
**返回：** `ConstIterator` - 返回值语义详见头文件声明。
执行 `end`、`Iterator` 协同流程。
**示例：**
## 当前实现
```cpp
#include <XCEngine/Core/Containers/HashMap.h>
void Example() {
XCEngine::Containers::HashMap object;
// 根据上下文补齐参数后调用 HashMap::end(...)。
(void)object;
}
```
- 当前实现会调用 `end`、`Iterator`。
- 包含条件分支，并可能提前返回。
- 包含 `nullptr` 相关分支。
- 当前实现会调用 `end`、`ConstIterator`。
## 相关文档
- [返回类总览](HashMap.md)
- [返回模块目录](../Containers.md)
- [HashMap](HashMap.md)