docs: update core and debug API docs
This commit is contained in:
@@ -3,43 +3,40 @@
|
||||
```cpp
|
||||
void Log(LogLevel level, LogCategory category,
|
||||
const Containers::String& message, const char* file = nullptr,
|
||||
int32_t line = 0, const char* function = nullptr)
|
||||
int32_t line = 0, const char* function = nullptr);
|
||||
```
|
||||
|
||||
通用日志记录方法。根据设置的最小日志级别和分类开关决定是否输出,然后将日志分发给所有已注册的 Sink。如果日志级别低于最小级别或分类被禁用,则不输出。
|
||||
通用日志记录方法,支持完整的日志信息包括源码位置。
|
||||
|
||||
**参数:**
|
||||
- `level` - 日志级别(Verbose, Debug, Info, Warning, Error, Fatal)
|
||||
- `category` - 日志分类(General, Rendering, Physics 等)
|
||||
- `level` - 日志级别(Verbose、Debug、Info、Warning、Error、Fatal)
|
||||
- `category` - 日志分类(General、Rendering、Physics 等)
|
||||
- `message` - 日志消息内容
|
||||
- `file` - 源代码文件路径(可选,默认 nullptr)
|
||||
- `line` - 源代码行号(可选,默认 0)
|
||||
- `function` - 函数名称(可选,默认 nullptr)
|
||||
- `file` - 源码文件名(可选)
|
||||
- `line` - 源码行号(可选)
|
||||
- `function` - 函数名(可选)
|
||||
|
||||
**返回:** 无
|
||||
|
||||
**复杂度:** O(n),n 为注册的 Sink 数量
|
||||
**线程安全:** ✅
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Debug/Logger.h>
|
||||
#include "XCEngine/Debug/Logger.h"
|
||||
|
||||
XCEngine::Debug::Logger::Get().Log(
|
||||
XCEngine::Debug::LogLevel::Error,
|
||||
XCEngine::Debug::LogCategory::FileSystem,
|
||||
"Failed to open config file",
|
||||
__FILE__,
|
||||
__LINE__,
|
||||
__FUNCTION__
|
||||
);
|
||||
using namespace XCEngine::Debug;
|
||||
|
||||
// 推荐使用 XE_LOG 宏自动填充位置信息
|
||||
XE_LOG(XCEngine::Debug::LogCategory::General, XCEngine::Debug::LogLevel::Info, "Initialized");
|
||||
Logger& logger = Logger::Get();
|
||||
|
||||
// 完整调用(包含源码位置)
|
||||
logger.Log(LogLevel::Error, LogCategory::Network,
|
||||
"Connection timeout", __FILE__, __LINE__, __FUNCTION__);
|
||||
|
||||
// 简化调用
|
||||
logger.Log(LogLevel::Info, LogCategory::General, "Simple message");
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [Logger 总览](logger.md) - 返回类总览
|
||||
- [LogLevel](../loglevel/loglevel.md) - 日志级别枚举
|
||||
- [LogCategory](../logcategory/logcategory.md) - 日志分类枚举
|
||||
- [Logger](logger.md) - 返回类总览
|
||||
|
||||
Reference in New Issue
Block a user