docs: 重构 API 文档结构并修正源码准确性
- 重组文档目录结构: 每个模块的概述页移动到模块子目录 - 重命名 index.md 为 main.md - 修正所有模块文档中的错误: - math: FromEuler→FromEulerAngles, TransformDirection 包含缩放, Box 是 OBB, Color::ToRGBA 格式 - containers: 新增 operator==/!= 文档, 补充 std::hash DJB 算法细节 - core: 修复 types 链接错误 - debug: LogLevelToString 返回大写, timestamp 是秒, Profiler 空实现标注, Windows API vs ANSI - memory: 修复头文件路径, malloc vs operator new, 新增方法文档 - resources: 修复 Shader/Texture 链接错误 - threading: TaskSystem::Wait 空实现标注, ReadWriteLock 重入描述, LambdaTask 链接 - 验证: fix_links.py 确认 0 个断裂引用
This commit is contained in:
37
docs/api/core/event/ProcessUnsubscribes.md
Normal file
37
docs/api/core/event/ProcessUnsubscribes.md
Normal file
@@ -0,0 +1,37 @@
|
||||
# Event::ProcessUnsubscribes
|
||||
|
||||
```cpp
|
||||
void ProcessUnsubscribes();
|
||||
```
|
||||
|
||||
处理积压的退订请求。
|
||||
|
||||
**描述**
|
||||
|
||||
手动处理待退订的回调,将其从订阅列表中移除。通常不需要手动调用,`Invoke` 会自动处理退订。但在某些场景下可能需要主动调用。
|
||||
|
||||
**复杂度:** O(n) 其中 n 为待退订数量
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Core/Event.h>
|
||||
|
||||
Event<int> event;
|
||||
|
||||
// 订阅
|
||||
uint64_t id = event.Subscribe([](int value) { });
|
||||
|
||||
// 退订请求入队
|
||||
event.Unsubscribe(id);
|
||||
|
||||
// 主动处理退订
|
||||
event.ProcessUnsubscribes();
|
||||
|
||||
// 此时事件列表中已无该回调
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [Event 总览](event.md) - 返回类总览
|
||||
- [Unsubscribe](Unsubscribe.md) - 退订事件
|
||||
Reference in New Issue
Block a user