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/String/CStr.md
View File

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

29
docs/api/XCEngine/Core/Containers/String/Capacity.md
View File

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

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

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

70
docs/api/XCEngine/Core/Containers/String/Constructor.md
View File

@@ -1,75 +1,33 @@
# String::String()
构造对象。
**命名空间**: `XCEngine::Containers`
该方法在 `XCEngine/Core/Containers/String.h` 中提供了 5 个重载，当前页面统一汇总这些公开声明。
**类型**: `method`
## 重载 1: 声明
**头文件**: `XCEngine/Core/Containers/String.h`
## 签名
```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` - 无返回值。
执行 `strlen`、`memcpy` 协同流程。
**示例：**
## 当前实现
```cpp
#include <XCEngine/Core/Containers/String.h>
void Example() {
XCEngine::Containers::String object;
}
```
- 会更新 `m_length`、`m_capacity`、`m_data`。
- 当前实现会调用 `strlen`、`memcpy`。
- 当前实现会调用 `memcpy`。
- 会更新 `m_data`、`m_length`、`m_capacity`。
- 包含 `nullptr` 相关分支。
## 相关文档
- [返回类总览](String.md)
- [返回模块目录](../Containers.md)
- [String](String.md)

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

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

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

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

38
docs/api/XCEngine/Core/Containers/String/EndsWith.md
View File

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

31
docs/api/XCEngine/Core/Containers/String/Find.md
View File

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

29
docs/api/XCEngine/Core/Containers/String/Length.md
View File

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

51
docs/api/XCEngine/Core/Containers/String/OperatorAssign.md
View File

@@ -1,55 +1,30 @@
# String::operator=
公开方法，详见头文件声明。
**命名空间**: `XCEngine::Containers`
该方法在 `XCEngine/Core/Containers/String.h` 中提供了 3 个重载，当前页面统一汇总这些公开声明。
**类型**: `method`
## 重载 1: 声明
**头文件**: `XCEngine/Core/Containers/String.h`
## 签名
```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&` - 返回值语义详见头文件声明。
更新 `m_length`。
**示例：**
## 当前实现
```cpp
#include <XCEngine/Core/Containers/String.h>
void Example() {
XCEngine::Containers::String object;
// 根据上下文补齐参数后调用 String::operator=(...)。
(void)object;
}
```
- 会更新 `m_length`。
- 当前实现会调用 `Deallocate`、`Allocate`、`memcpy`。
- 包含条件分支，并可能提前返回。
- 当前实现会调用 `strlen`、`Deallocate`、`Allocate`、`memcpy`、`Clear`。
## 相关文档
- [返回类总览](String.md)
- [返回模块目录](../Containers.md)
- [String](String.md)

51
docs/api/XCEngine/Core/Containers/String/OperatorPlusAssign.md
View File

@@ -1,55 +1,30 @@
# String::operator+=
公开方法，详见头文件声明。
**命名空间**: `XCEngine::Containers`
该方法在 `XCEngine/Core/Containers/String.h` 中提供了 3 个重载，当前页面统一汇总这些公开声明。
**类型**: `method`
## 重载 1: 声明
**头文件**: `XCEngine/Core/Containers/String.h`
## 签名
```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&` - 返回值语义详见头文件声明。
执行 `memcpy` 协同流程。
**示例：**
## 当前实现
```cpp
#include <XCEngine/Core/Containers/String.h>
void Example() {
XCEngine::Containers::String object;
// 根据上下文补齐参数后调用 String::operator+=(...)。
(void)object;
}
```
- 会更新 `m_data`、`m_capacity`、`m_length`。
- 当前实现会调用 `memcpy`。
- 包含条件分支，并可能提前返回。
- 当前实现会调用 `strlen`、`memcpy`。
## 相关文档
- [返回类总览](String.md)
- [返回模块目录](../Containers.md)
- [String](String.md)

38
docs/api/XCEngine/Core/Containers/String/OperatorSubscript.md
View File

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

31
docs/api/XCEngine/Core/Containers/String/Reserve.md
View File

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

41
docs/api/XCEngine/Core/Containers/String/Resize.md
View File

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

38
docs/api/XCEngine/Core/Containers/String/StartsWith.md
View File

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

31
docs/api/XCEngine/Core/Containers/String/Substring.md
View File

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

29
docs/api/XCEngine/Core/Containers/String/ToLower.md
View File

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

29
docs/api/XCEngine/Core/Containers/String/ToUpper.md
View File

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

29
docs/api/XCEngine/Core/Containers/String/Trim.md
View File

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