docs: update core and debug API docs
This commit is contained in:
@@ -1,30 +1,37 @@
|
||||
# Logger::SetMinimumLevel
|
||||
|
||||
```cpp
|
||||
void SetMinimumLevel(LogLevel level)
|
||||
void SetMinimumLevel(LogLevel level);
|
||||
```
|
||||
|
||||
设置日志系统的最小输出级别。所有低于该级别的日志将被过滤,不会分发给任何 Sink。
|
||||
设置最低日志级别。只会记录等于或高于此级别的日志,低于该级别的日志将被忽略。
|
||||
|
||||
**参数:**
|
||||
- `level` - 最小日志级别
|
||||
- `level` - 最低日志级别
|
||||
|
||||
**复杂度:** O(1)
|
||||
**返回:** 无
|
||||
|
||||
**线程安全:** ✅
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Debug/Logger.h>
|
||||
#include "XCEngine/Debug/Logger.h"
|
||||
|
||||
// 只输出 Warning 及以上级别的日志
|
||||
XCEngine::Debug::Logger::Get().SetMinimumLevel(XCEngine::Debug::LogLevel::Warning);
|
||||
using namespace XCEngine::Debug;
|
||||
|
||||
// Verbose 和 Debug 级别的日志将被过滤
|
||||
XCEngine::Debug::Logger::Get().Verbose(XCEngine::Debug::LogCategory::General, "This will not be logged");
|
||||
XCEngine::Debug::Logger::Get().Warning(XCEngine::Debug::LogCategory::General, "This will be logged");
|
||||
Logger& logger = Logger::Get();
|
||||
|
||||
// 只记录 Warning 及以上级别
|
||||
logger.SetMinimumLevel(LogLevel::Warning);
|
||||
|
||||
logger.Verbose(LogCategory::General, "This won't be logged");
|
||||
logger.Debug(LogCategory::General, "This won't be logged");
|
||||
logger.Info(LogCategory::General, "This won't be logged");
|
||||
logger.Warning(LogCategory::General, "This WILL be logged");
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [Logger 总览](logger.md) - 返回类总览
|
||||
- [Logger](logger.md) - 返回类总览
|
||||
- [LogLevel](../loglevel/loglevel.md) - 日志级别枚举
|
||||
|
||||
Reference in New Issue
Block a user