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,29 +1,44 @@
# Logger::Get
获取相关状态或对象
获取进程级全局 `Logger` 实例
```cpp
static Logger& Get();
```
该方法声明于 `XCEngine/Debug/Logger.h`,当前页面用于固定 `Logger` 类目录下的方法级 canonical 路径。
## 行为说明
**参数:** 无。
**返回:** `Logger&` - 返回值语义详见头文件声明。
**示例:**
当前实现使用函数内静态对象保存单例:
```cpp
#include <XCEngine/Debug/Logger.h>
static Logger instance;
```
void Example() {
auto& instance = XCEngine::Debug::Logger::Get();
(void)instance;
}
因此:
- 你拿到的是同一个 `Logger` 实例引用。
- 该方法本身不会自动初始化 sink也不会重置过滤配置。
## 参数
- 无。
## 返回值
- `Logger&` - 全局日志分发器引用。
## 线程语义
- C++ 对函数内静态对象初始化提供线程安全保证,但 `Logger` 的后续配置和使用仍需遵守各自方法的线程语义。
## 示例
```cpp
XCEngine::Debug::Logger& logger = XCEngine::Debug::Logger::Get();
logger.Initialize();
```
## 相关文档
- [返回类总览](Logger.md)
- [返回模块目录](../Debug.md)
- [返回类总览](Logger.md)
- [Initialize](Initialize.md)