docs: rebuild Debug API content
This commit is contained in:
@@ -6,30 +6,50 @@
|
||||
|
||||
**头文件**: `XCEngine/Debug/ConsoleLogSink.h`
|
||||
|
||||
**描述**: 定义 `XCEngine/Debug` 子目录中的 `ConsoleLogSink` public API。
|
||||
**描述**: 将日志输出到标准输出流,并在 Windows 上按级别着色。
|
||||
|
||||
## 概述
|
||||
|
||||
`ConsoleLogSink.h` 是 `XCEngine/Debug` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
`ConsoleLogSink` 是最直接的调试输出目标,适合测试程序、命令行工具和开发期编辑器启动日志。它本身只关心“如何写到控制台”,不过滤 category,也不处理文件、函数名和时间戳格式化以外的元数据。
|
||||
|
||||
## 声明概览
|
||||
当前实现中的关键行为:
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `ConsoleLogSink` | `class` | 继承自 `ILogSink` 的公开声明。 |
|
||||
- 日志格式固定为 `[LEVEL] [Category] message`。
|
||||
- 颜色输出只在 `_WIN32` 下生效;其它平台仍会输出文本,但不会着色。
|
||||
- sink 自身维护一个最小级别阈值,可在 `Logger` 的全局过滤之后再做一次本地过滤。
|
||||
|
||||
## 公共方法
|
||||
## 生命周期
|
||||
|
||||
| 方法 | 描述 |
|
||||
- [Constructor](Constructor.md) 创建 sink,默认开启颜色输出,最小级别为 `Verbose`。
|
||||
- [Destructor](Destructor.md) 无额外资源释放逻辑。
|
||||
- [Flush](Flush.md) 手动刷新 `stdout`。
|
||||
|
||||
## 线程语义
|
||||
|
||||
- `ConsoleLogSink` 自身没有加锁。
|
||||
- 通过 `Logger` 调用时,实际输出发生在 `Logger` 的互斥区内,因此同一时刻只会有一个 sink 调用进入。
|
||||
- 如果绕过 `Logger` 直接从多个线程调用 `Log`,线程安全由调用方自己保证。
|
||||
|
||||
## 公开方法
|
||||
|
||||
| 方法 | 说明 |
|
||||
|------|------|
|
||||
| [ConsoleLogSink()](Constructor.md) | 构造对象。 |
|
||||
| [~ConsoleLogSink()](Destructor.md) | 销毁对象并释放相关资源。 |
|
||||
| [Log](Log.md) | 公开方法,详见头文件声明。 |
|
||||
| [Flush](Flush.md) | 公开方法,详见头文件声明。 |
|
||||
| [SetColorOutput](SetColorOutput.md) | 设置相关状态或配置。 |
|
||||
| [SetMinimumLevel](SetMinimumLevel.md) | 设置相关状态或配置。 |
|
||||
| [Constructor](Constructor.md) | 构造一个控制台日志 sink。 |
|
||||
| [Destructor](Destructor.md) | 析构 sink。 |
|
||||
| [Log](Log.md) | 将一条日志格式化写入 `stdout`。 |
|
||||
| [Flush](Flush.md) | 刷新 `stdout`。 |
|
||||
| [SetColorOutput](SetColorOutput.md) | 开关 Windows 控制台颜色。 |
|
||||
| [SetMinimumLevel](SetMinimumLevel.md) | 设置 sink 级别阈值。 |
|
||||
|
||||
## 适用场景
|
||||
|
||||
- 单元测试与集成测试的即时输出。
|
||||
- 编辑器或工具进程启动阶段的可见日志。
|
||||
- 临时调试某个后端时,为 `Logger` 追加一个低成本输出目标。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Debug.md) - 返回 `Debug` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
- [当前模块](../Debug.md)
|
||||
- [Logger](../Logger/Logger.md)
|
||||
- [ILogSink](../ILogSink/ILogSink.md)
|
||||
- [Logging Architecture](../../../_guides/Debug/Logging-Architecture.md)
|
||||
|
||||
Reference in New Issue
Block a user