docs: rebuild Debug API content
This commit is contained in:
@@ -1,30 +1,49 @@
|
||||
# Logger::Initialize
|
||||
|
||||
初始化内部状态。
|
||||
把 `Logger` 标记为已初始化。
|
||||
|
||||
```cpp
|
||||
void Initialize();
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Debug/Logger.h`,当前页面用于固定 `Logger` 类目录下的方法级 canonical 路径。
|
||||
## 行为说明
|
||||
|
||||
**参数:** 无。
|
||||
当前实现是幂等的:
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
- 如果已经初始化,直接返回。
|
||||
- 如果尚未初始化,仅把内部 `m_initialized` 设为 `true`。
|
||||
|
||||
**示例:**
|
||||
它不会做以下事情:
|
||||
|
||||
- 不会添加默认 sink。
|
||||
- 不会清空已有 sink。
|
||||
- 不会重置最小级别或 category 开关。
|
||||
|
||||
因此,推荐把它理解为“进入可用状态”的轻量标记,而不是完整的日志系统自举流程。
|
||||
|
||||
## 参数
|
||||
|
||||
- 无。
|
||||
|
||||
## 返回值
|
||||
|
||||
- 无。
|
||||
|
||||
## 线程语义
|
||||
|
||||
- 当前实现没有显式同步初始化流程;如果多线程首次同时写日志,`Log` 的自动初始化路径虽然通常能工作,但仍建议在启动阶段显式调用一次。
|
||||
|
||||
## 示例
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Debug/Logger.h>
|
||||
using namespace XCEngine::Debug;
|
||||
|
||||
void Example() {
|
||||
XCEngine::Debug::Logger object;
|
||||
// 根据上下文补齐参数后调用 Logger::Initialize(...)。
|
||||
(void)object;
|
||||
}
|
||||
Logger::Get().Initialize();
|
||||
Logger::Get().AddSink(std::make_unique<ConsoleLogSink>());
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](Logger.md)
|
||||
- [返回模块目录](../Debug.md)
|
||||
- [返回类型总览](Logger.md)
|
||||
- [Shutdown](Shutdown.md)
|
||||
- [Log](Log.md)
|
||||
|
||||
Reference in New Issue
Block a user