docs: remove redundant Debug umbrella page

This commit is contained in:
2026-03-26 17:27:30 +08:00
parent 7a814c724d
commit ec4edb2689
4 changed files with 32 additions and 54 deletions

View File

@@ -27,10 +27,18 @@
- `Profiler``RenderDocCapture` 都采用单例,目的是让工具、测试和引擎运行时共享一套调试入口。
- 该模块偏开发期工具能力,不追求零侵入;一些 API 会主动写日志、刷新文件或拉起窗口焦点。
## 聚合头文件
**头文件**: `XCEngine/Debug/Debug.h`
`Debug.h` 是这个模块的 umbrella header。它本身不代表新的运行时类型而是把 `Logger``Profiler``RenderDocCapture` 等常用 public header 聚合成一个便利入口。
对读者来说,最合理的入口仍然是当前这页,而不是再进入一个同名的 `Debug/Debug.md` 类型页。
## 头文件
- [ConsoleLogSink](ConsoleLogSink/ConsoleLogSink.md) - `ConsoleLogSink.h`,面向 `stdout` 的日志输出 sink。
- [Debug](Debug/Debug.md) - `Debug.h`,聚合调试模块所有 public header 的便利入口
- `Debug.h` - 模块聚合头,说明已并入当前页
- [FileLogSink](FileLogSink/FileLogSink.md) - `FileLogSink.h`,将日志追加写入文件。
- [ILogSink](ILogSink/ILogSink.md) - `ILogSink.h`,日志输出目标接口。
- [LogCategory](LogCategory/LogCategory.md) - `LogCategory.h`,日志功能分类枚举。