docs: rebuild Debug API content
This commit is contained in:
@@ -1,32 +1,43 @@
|
||||
# Logger::SetCategoryEnabled
|
||||
|
||||
设置相关状态或配置。
|
||||
打开或关闭某个日志分类。
|
||||
|
||||
```cpp
|
||||
void SetCategoryEnabled(LogCategory category, bool enabled);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Debug/Logger.h`,当前页面用于固定 `Logger` 类目录下的方法级 canonical 路径。
|
||||
## 行为说明
|
||||
|
||||
**参数:**
|
||||
- `category` - 参数语义详见头文件声明。
|
||||
- `enabled` - 参数语义详见头文件声明。
|
||||
当前实现会把 `category` 对应的启用位直接写入内部数组。之后所有 `Log` 调用都会先检查这个开关,再决定是否分发该分类日志。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
这是一种非常轻量的 category 过滤方式,但也意味着:
|
||||
|
||||
**示例:**
|
||||
- 当前实现没有加锁。
|
||||
- 枚举值数量与数组长度耦合。
|
||||
|
||||
## 参数
|
||||
|
||||
- `category` - 需要开关的日志分类。
|
||||
- `enabled` - `true` 表示启用,`false` 表示禁用。
|
||||
|
||||
## 返回值
|
||||
|
||||
- 无。
|
||||
|
||||
## 线程语义
|
||||
|
||||
- 建议在初始化阶段配置,而不是在多个线程持续写日志时频繁修改。
|
||||
|
||||
## 示例
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Debug/Logger.h>
|
||||
using namespace XCEngine::Debug;
|
||||
|
||||
void Example() {
|
||||
XCEngine::Debug::Logger object;
|
||||
// 根据上下文补齐参数后调用 Logger::SetCategoryEnabled(...)。
|
||||
(void)object;
|
||||
}
|
||||
Logger::Get().SetCategoryEnabled(LogCategory::Rendering, false);
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](Logger.md)
|
||||
- [返回模块目录](../Debug.md)
|
||||
- [返回类型总览](Logger.md)
|
||||
- [SetMinimumLevel](SetMinimumLevel.md)
|
||||
- [LogCategory](../LogCategory/LogCategory.md)
|
||||
|
||||
Reference in New Issue
Block a user