docs: update core and debug API docs
This commit is contained in:
@@ -1,26 +1,28 @@
|
||||
# Logger::Shutdown
|
||||
|
||||
```cpp
|
||||
void Shutdown()
|
||||
void Shutdown();
|
||||
```
|
||||
|
||||
关闭日志系统。移除所有注册的 Sink,刷新缓冲区并重置内部状态。在程序退出前调用,确保所有日志数据已写入输出目标。
|
||||
关闭日志系统并清理资源。调用此方法后会停止所有日志记录操作并释放相关资源。在程序退出前应调用此方法。
|
||||
|
||||
**线程安全:** ❌(应在单线程退出阶段调用)
|
||||
|
||||
**复杂度:** O(n),n 为注册的 Sink 数量
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Debug/Logger.h>
|
||||
#include "XCEngine/Debug/Logger.h"
|
||||
|
||||
int main() {
|
||||
XCEngine::Debug::Logger::Get().Initialize();
|
||||
// ... 应用逻辑 ...
|
||||
XCEngine::Debug::Logger::Get().Shutdown();
|
||||
return 0;
|
||||
}
|
||||
using namespace XCEngine::Debug;
|
||||
|
||||
Logger& logger = Logger::Get();
|
||||
logger.Info(LogCategory::General, "Shutting down...");
|
||||
logger.Shutdown();
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [Logger 总览](logger.md) - 返回类总览
|
||||
- [Logger](logger.md) - 返回类总览
|
||||
- [Initialize](initialize.md) - 初始化日志系统
|
||||
|
||||
Reference in New Issue
Block a user