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,28 +1,28 @@
# Logger::Initialize
```cpp
void Initialize()
void Initialize();
```
初始化日志系统。在首次使用日志功能前必须调用。初始化内部状态标志,确保日志系统已准备好工作
初始化日志系统。在首次使用 Logger 前必须调用此方法进行初始化。初始化过程会设置内部状态并准备日志记录环境
**注意** 默认最小日志级别为 `Verbose`,所有日志分类默认启用,这些是类成员变量的默认值,不需要在此方法中设置。
**线程安全** ❌(应在单线程启动阶段调用)
**复杂度:** O(1)
**示例:**
```cpp
#include <XCEngine/Debug/Logger.h>
#include "XCEngine/Debug/Logger.h"
int main() {
XCEngine::Debug::Logger::Get().Initialize();
XCEngine::Debug::Logger::Get().AddSink(std::make_unique<XCEngine::Debug::ConsoleLogSink>());
XCEngine::Debug::Logger::Get().Info(XCEngine::Debug::LogCategory::General, "Application started");
return 0;
}
using namespace XCEngine::Debug;
Logger& logger = Logger::Get();
logger.Initialize();
logger.Info(LogCategory::General, "System initialized");
```
## 相关文档
- [Logger 总览](logger.md) - 返回类总览
- [Logger](logger.md) - 返回类总览
- [Shutdown](shutdown.md) - 关闭日志系统