docs: rebuild Debug API content

This commit is contained in:
2026-03-26 17:21:44 +08:00
parent 122495e581
commit 2e2316aa55
69 changed files with 2371 additions and 1092 deletions

View File

@@ -1,31 +1,43 @@
# ConsoleLogSink::SetMinimumLevel
设置相关状态或配置
设置该 sink 自己接受的最低日志级别
```cpp
void SetMinimumLevel(LogLevel level);
```
该方法声明于 `XCEngine/Debug/ConsoleLogSink.h`,当前页面用于固定 `ConsoleLogSink` 类目录下的方法级 canonical 路径。
## 行为说明
**参数:**
- `level` - 参数语义详见头文件声明。
这是 sink 级过滤,不是全局过滤。日志只有同时通过了:
**返回:** `void` - 无返回值。
- `Logger` 的全局级别与 category 过滤;
- `ConsoleLogSink` 的本地级别过滤;
**示例:**
才会真正输出到控制台。
## 参数
- `level` - 该 sink 允许输出的最小级别。
## 返回值
- 无。
## 线程语义
- 当前实现没有加锁;建议在把 sink 注册到 `Logger` 前完成配置。
## 示例
```cpp
#include <XCEngine/Debug/ConsoleLogSink.h>
using namespace XCEngine::Debug;
void Example() {
XCEngine::Debug::ConsoleLogSink object;
// 根据上下文补齐参数后调用 ConsoleLogSink::SetMinimumLevel(...)。
(void)object;
}
auto sink = std::make_unique<ConsoleLogSink>();
sink->SetMinimumLevel(LogLevel::Warning);
Logger::Get().AddSink(std::move(sink));
```
## 相关文档
- [返回类总览](ConsoleLogSink.md)
- [返回模块目录](../Debug.md)
- [返回类总览](ConsoleLogSink.md)
- [Logger::SetMinimumLevel](../Logger/SetMinimumLevel.md)