docs: update core and debug API docs
This commit is contained in:
@@ -6,6 +6,12 @@ virtual void Flush() = 0
|
||||
|
||||
刷新输出缓冲区,确保所有待写入的日志数据已实际写入目标介质。对于文件类 Sink,应调用底层文件系统的 flush;对于网络类 Sink,应发送缓冲区中的数据。
|
||||
|
||||
**返回:** 无
|
||||
|
||||
**异常:** 无
|
||||
|
||||
**线程安全:** ✅ 线程安全
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
@@ -4,6 +4,8 @@
|
||||
|
||||
**类型**: `class` (abstract interface)
|
||||
|
||||
**头文件**: `XCEngine/Debug/ILogSink.h`
|
||||
|
||||
**描述**: 日志输出槽抽象接口,定义日志输出的标准协议。
|
||||
|
||||
## 概述
|
||||
@@ -14,8 +16,8 @@
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| `virtual void Log(const LogEntry& entry) = 0` | [输出单条日志](log.md) |
|
||||
| `virtual void Flush() = 0` | [刷新缓冲区,确保日志写入](flush.md) |
|
||||
| [`Log`](log.md) | 输出单条日志 |
|
||||
| [`Flush`](flush.md) | 刷新缓冲区,确保日志写入 |
|
||||
|
||||
## 使用示例
|
||||
|
||||
|
||||
@@ -9,7 +9,11 @@ virtual void Log(const LogEntry& entry) = 0
|
||||
**参数:**
|
||||
- `entry` - 日志条目,包含级别、分类、消息、时间戳、线程 ID 等完整信息
|
||||
|
||||
**复杂度:** O(1)
|
||||
**返回:** 无
|
||||
|
||||
**异常:** 无
|
||||
|
||||
**线程安全:** ✅ 线程安全
|
||||
|
||||
**示例:**
|
||||
|
||||
|
||||
Reference in New Issue
Block a user