docs: update core and debug API docs

This commit is contained in:
2026-03-20 02:35:07 +08:00
parent 0c073db4e8
commit e165dbea1c
73 changed files with 743 additions and 391 deletions

View File

@@ -1,21 +1,50 @@
# ConsoleLogSink::ConsoleLogSink
# ConsoleLogSink
**命名空间**: `XCEngine::Debug`
**类型**: `class`
**头文件**: `XCEngine/Debug/ConsoleLogSink.h`
**描述**: 控制台日志输出目标,将日志输出到标准输出流。
## 概述
`ConsoleLogSink` 是日志系统的控制台输出实现。它将日志条目输出到标准输出流stdout支持彩色输出和日志级别过滤。该类继承自 `ILogSink` 接口,可通过 `Logger::AddSink` 添加到日志系统。
设计用于开发调试场景,默认启用彩色输出便于在终端中区分不同日志级别。
## 公共方法
| 方法 | 描述 |
|------|------|
| [`ConsoleLogSink()`](constructor.md) | 构造函数 |
| [`~ConsoleLogSink`](destructor.md) | 析构函数 |
| [`Log`](log.md) | 输出日志到控制台 |
| [`Flush`](flush.md) | 刷新输出流 |
| [`SetColorOutput`](setcoloroutput.md) | 设置彩色输出 |
| [`SetMinimumLevel`](setminimumlevel.md) | 设置最小日志级别 |
## 使用示例
```cpp
ConsoleLogSink()
```
#include <XCEngine/Debug/ConsoleLogSink.h>
默认构造函数。创建一个 `ConsoleLogSink` 实例,默认启用彩色输出,最小日志级别为 `Verbose`
**复杂度:** O(1)
**示例:**
```cpp
auto sink = std::make_unique<XCEngine::Debug::ConsoleLogSink>();
sink->SetColorOutput(true);
sink->SetMinimumLevel(XCEngine::Debug::LogLevel::Warning);
XCEngine::Debug::Logger::Get().AddSink(std::move(sink));
```
## 构造函数详细
| 属性 | 值 |
|------|-----|
| 默认 `m_colorOutput` | `true` |
| 默认 `m_minimumLevel` | `LogLevel::Verbose` |
## 相关文档
- [ConsoleLogSink 总览](overview.md) - 返回类总览
- [Debug 模块总览](../debug.md) - 返回模块总览
- [Logger](../logger/logger.md) - 日志记录器
- [ILogSink](../ilogsink/ilogsink.md) - 日志输出接口