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:
41
docs/api/core/event/Unsubscribe.md
Normal file
41
docs/api/core/event/Unsubscribe.md
Normal file
@@ -0,0 +1,41 @@
|
||||
# Event::Unsubscribe
|
||||
|
||||
```cpp
|
||||
void Unsubscribe(uint64_t id);
|
||||
```
|
||||
|
||||
退订事件。
|
||||
|
||||
**描述**
|
||||
|
||||
将指定 ID 的回调从订阅列表中移除。退订是延迟生效的,在调用 `Invoke` 时会一并处理待退订的回调。线程安全,可在任意线程调用。
|
||||
|
||||
**参数:**
|
||||
- `id` - 订阅时返回的 ID
|
||||
|
||||
**复杂度:** O(n) 在 Invoke 时处理
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Core/Event.h>
|
||||
|
||||
Event<int> someEvent;
|
||||
|
||||
// 订阅
|
||||
uint64_t id = someEvent.Subscribe([](int value) {
|
||||
printf("Value: %d\n", value);
|
||||
});
|
||||
|
||||
// 退订
|
||||
someEvent.Unsubscribe(id);
|
||||
|
||||
// 触发(已退订的回调不会被调用)
|
||||
someEvent.Invoke(42);
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [Event 总览](event.md) - 返回类总览
|
||||
- [Subscribe](Subscribe.md) - 订阅事件
|
||||
- [ProcessUnsubscribes](ProcessUnsubscribes.md) - 手动处理退订
|
||||
Reference in New Issue
Block a user