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

docs: 更新 containers 和 threading 模块文档

Browse Source 
- containers: 更新 string 类的多个方法文档
- threading: 更新 mutex 和 task-group 方法文档
This commit is contained in:
ssdfasd
2026-03-26 01:59:14 +08:00
parent 8df04c120f
commit 5c3566774b
42 changed files with 714 additions and 96 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/api/containers/array/begin-end.md
View File

@@ -22,7 +22,7 @@ ConstIterator end() const;
**示例：**
```cpp
#include <XCEngine/Containers/Array.h>
#include <XCEngine/Core/Containers/Array.h>
XCEngine::Containers::Array<int> arr = {10, 20, 30, 40, 50};

2
docs/api/containers/array/constructor.md
View File

@@ -28,7 +28,7 @@ Array(std::initializer_list<T> init);
**示例：**
```cpp
#include <XCEngine/Containers/Array.h>
#include <XCEngine/Core/Containers/Array.h>
using namespace XCEngine::Containers;

2
docs/api/containers/string/clear.md
View File

@@ -14,7 +14,7 @@ void Clear();
**示例：**
```cpp
#include "XCEngine/Containers/String.h"
#include "XCEngine/Core/Containers/String.h"
#include <iostream>
int main() {

2
docs/api/containers/string/constructor.md
View File

@@ -25,7 +25,7 @@ String(String&& other) noexcept;
**示例：**
```cpp
#include "XCEngine/Containers/String.h"
#include "XCEngine/Core/Containers/String.h"
#include <iostream>
int main() {

2
docs/api/containers/string/cstr.md
View File

@@ -14,7 +14,7 @@ const char* CStr() const;
**示例：**
```cpp
#include "XCEngine/Containers/String.h"
#include "XCEngine/Core/Containers/String.h"
#include <iostream>
#include <cstring>

2
docs/api/containers/string/destructor.md
View File

@@ -14,7 +14,7 @@
**示例：**
```cpp
#include "XCEngine/Containers/String.h"
#include "XCEngine/Core/Containers/String.h"
int main() {
{

2
docs/api/containers/string/ends-with.md
View File

@@ -16,7 +16,7 @@ bool EndsWith(const char* suffix) const;
**示例：**
```cpp
#include "XCEngine/Containers/String.h"
#include "XCEngine/Core/Containers/String.h"
#include <iostream>
int main() {

2
docs/api/containers/string/find.md
View File

@@ -16,7 +16,7 @@ SizeType Find(const char* str, SizeType pos = 0) const;
**示例：**
```cpp
#include "XCEngine/Containers/String.h"
#include "XCEngine/Core/Containers/String.h"
#include <iostream>
int main() {

2
docs/api/containers/string/operator-assign.md
View File

@@ -21,7 +21,7 @@ String& operator=(const char* str);
**示例：**
```cpp
#include "XCEngine/Containers/String.h"
#include "XCEngine/Core/Containers/String.h"
#include <iostream>
int main() {

2
docs/api/containers/string/operator-equal.md
View File

@@ -21,7 +21,7 @@ inline bool operator!=(const String& lhs, const String& rhs);
**示例：**
```cpp
#include "XCEngine/Containers/String.h"
#include "XCEngine/Core/Containers/String.h"
#include <iostream>
int main() {

2
docs/api/containers/string/operator-plus-assign.md
View File

@@ -19,7 +19,7 @@ String& operator+=(char c);
**示例：**
```cpp
#include "XCEngine/Containers/String.h"
#include "XCEngine/Core/Containers/String.h"
#include <iostream>
int main() {

2
docs/api/containers/string/operator-plus.md
View File

@@ -16,7 +16,7 @@ inline String operator+(const String& lhs, const String& rhs);
**示例：**
```cpp
#include "XCEngine/Containers/String.h"
#include "XCEngine/Core/Containers/String.h"
#include <iostream>
int main() {

2
docs/api/containers/string/operator-subscript.md
View File

@@ -18,7 +18,7 @@ const char& operator[](SizeType index) const;
**示例：**
```cpp
#include "XCEngine/Containers/String.h"
#include "XCEngine/Core/Containers/String.h"
#include <iostream>
int main() {

2
docs/api/core/filewriter/Write.md
View File

@@ -26,7 +26,7 @@ bool Write(const Containers::String& str);
```cpp
#include <XCEngine/Core/FileWriter.h>
#include <XCEngine/Containers/String.h>
#include <XCEngine/Core/Containers/String.h>
using namespace XCEngine::Core;

2
docs/api/resources/mesh/mesh.md
View File

@@ -78,7 +78,7 @@ struct MeshSection {
```cpp
#include "XCEngine/Resources/Mesh.h"
#include "XCEngine/Containers/Array.h"
#include "XCEngine/Core/Containers/Array.h"
using namespace XCEngine;
using namespace Resources;

2
docs/api/threading/mutex/lock-const.md
View File

@@ -22,7 +22,7 @@ void lock() const;
#include "XCEngine/Threading/Mutex.h"
#include <mutex>
XCEngine::XCEngine::Threading::Mutex mtx;
XCEngine::Threading::Mutex mtx;
int counter = 0;
void Increment() {

2
docs/api/threading/mutex/try-lock-const.md
View File

@@ -22,7 +22,7 @@ bool try_lock() const;
#include "XCEngine/Threading/Mutex.h"
#include <iostream>
XCEngine::XCEngine::Threading::Mutex mtx;
XCEngine::Threading::Mutex mtx;
volatile bool updated = false;
void TryUpdate() {

2
docs/api/threading/mutex/unlock-const.md
View File

@@ -19,7 +19,7 @@ void unlock() const;
```cpp
#include "XCEngine/Threading/Mutex.h"
XCEngine::XCEngine::Threading::Mutex mtx;
XCEngine::Threading::Mutex mtx;
std::vector<int> data;
void SafePush(int value) {

2
docs/api/threading/task-group/constructor.md
View File

@@ -16,7 +16,7 @@ TaskGroup();
**注意：**
- 构造后的任务组不包含任何任务。
- 任务组创建后需要通过 TaskSystem::CreateTaskGroup() 实际创建。
- TaskGroup 可以独立使用，也可以通过 TaskSystem::CreateTaskGroup() 创建（后者会将任务组注册到任务系统管理）。
**示例：**

2
docs/api/threading/task/release.md
View File

@@ -29,4 +29,4 @@ task->Release(); // 引用计数 = 0，任务被 delete
## 相关文档
- [ITask 总览](task.md) - 返回类总览
- [AddRef](../../core/refcounted/addref.md) - 增加引用计数
- [AddRef](../../core/refcounted/AddRef.md) - 增加引用计数