docs: fix threading module documentation discrepancies

- Fix include paths: use #include "Threading/..." instead of <XCEngine/Threading/...>
- Document protected ITask constructors (ITask(), ITask(TaskPriority))
- Document Callback typedef in TaskGroup
- Clarify Mutex STL-compatible methods are const
- Note GetProgress() implementation limitation (returns 0.0f)
This commit is contained in:
2026-03-19 00:49:08 +08:00
parent 98c764bab9
commit 6a952473ce
12 changed files with 28 additions and 15 deletions

View File

@@ -1,7 +1,8 @@
# String::Length / Capacity / Empty
# String::Length / Size / Capacity / Empty
```cpp
SizeType Length() const;
SizeType Size() const;
SizeType Capacity() const;
bool Empty() const;
```
@@ -12,6 +13,7 @@ bool Empty() const;
**返回:**
- `Length()` - 返回字符串的字符数(不包括终止 null 字符)
- `Size()` - 与 `Length()` 功能相同,返回字符串的字符数
- `Capacity()` - 返回已分配的存储容量
- `Empty()` - 如果字符串为空则返回 `true`
@@ -28,6 +30,7 @@ int main() {
XCEngine::Containers::String s2("Hello");
std::cout << "Length: " << s2.Length() << std::endl; // 输出: Length: 5
std::cout << "Size: " << s2.Size() << std::endl; // 输出: Size: 5
std::cout << "Capacity: " << s2.Capacity() << std::endl; // 输出: Capacity: 6 或更大
s2.Reserve(100);

View File

@@ -62,7 +62,7 @@
| 方法 | 描述 |
|------|------|
| [CStr](cstr.md) | 获取 C 字符串指针 |
| [Length/Capacity/Empty](size.md) | 获取尺寸信息 |
| [Length/Size/Capacity/Empty](size.md) | 获取尺寸信息 |
| [operator[]](./operator-subscript.md) | 下标访问 |
### 容量管理

View File

@@ -4,7 +4,7 @@
String Trim() const;
```
移除字符串两端的空白字符(包括空格、制表符、换行符等 isspace 识别的字符),返回一个新的 String 对象,原字符串不变。
移除字符串两端的空白字符(空格、制表符、换行符、回车符),返回一个新的 String 对象,原字符串不变。
**参数:**
@@ -24,7 +24,7 @@ int main() {
std::cout << "\"" << trimmed.CStr() << "\"" << std::endl; // 输出: "Hello World"
XCEngine::Containers::String s2("\t\n test \t\n");
std::cout << "\"" << s2.Trim().CStr() << "\"" << std::endl; // 输出: "test"
std::cout << "\"" << s2.Trim().CStr() << "\"" << std::endl; // 输出: "test" (空格、制表符、换行、回车被移除)
return 0;
}