docs: update core and debug API docs
This commit is contained in:
@@ -1,10 +1,10 @@
|
||||
# Logger::Fatal
|
||||
|
||||
```cpp
|
||||
void Fatal(LogCategory category, const Containers::String& message)
|
||||
void Fatal(LogCategory category, const Containers::String& message);
|
||||
```
|
||||
|
||||
记录一条 Fatal(5 级)日志。Fatal 级别用于表示不可恢复的严重错误,通常意味着程序即将终止。此方法可能在记录日志后触发程序中断。
|
||||
记录 Fatal 级别日志。用于记录致命错误,表示程序无法继续运行。通常用于 `XE_ASSERT` 宏中。
|
||||
|
||||
**参数:**
|
||||
- `category` - 日志分类
|
||||
@@ -12,19 +12,20 @@ void Fatal(LogCategory category, const Containers::String& message)
|
||||
|
||||
**返回:** 无
|
||||
|
||||
**复杂度:** O(n),n 为注册的 Sink 数量
|
||||
**线程安全:** ✅
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Debug/Logger.h>
|
||||
#include "XCEngine/Debug/Logger.h"
|
||||
|
||||
XCEngine::Debug::Logger::Get().Fatal(
|
||||
XCEngine::Debug::LogCategory::General,
|
||||
"Out of memory - cannot continue"
|
||||
);
|
||||
using namespace XCEngine::Debug;
|
||||
|
||||
Logger& logger = Logger::Get();
|
||||
logger.Fatal(LogCategory::General, "Critical system failure");
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [Logger 总览](logger.md) - 返回类总览
|
||||
- [Logger](logger.md) - 返回类总览
|
||||
- [LogLevel](../loglevel/loglevel.md) - 日志级别说明
|
||||
|
||||
Reference in New Issue
Block a user