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`,日志功能分类枚举。

View File

@@ -1,46 +0,0 @@
# Debug
**命名空间**: `XCEngine::Debug`
**类型**: `header-umbrella`
**头文件**: `XCEngine/Debug/Debug.h`
**描述**: 聚合调试模块主要 public header 的便利包含入口。
## 概述
`Debug.h` 自身不定义新的核心类型,它的主要作用是把调试子系统的常用头文件集中包含进来,方便工具程序、测试程序或示例快速接入调试能力。
当前头文件会聚合:
- `LogLevel.h`
- `LogCategory.h`
- `LogEntry.h`
- `ILogSink.h`
- `ConsoleLogSink.h`
- `FileLogSink.h`
- `Logger.h`
- `Profiler.h`
- `RenderDocCapture.h`
- `../Core/FileWriter.h`
## 设计建议
- 对于快速原型、测试或示例程序,直接包含 `Debug.h` 比逐个包含更方便。
- 对于大型模块或编译敏感代码,建议只包含真正需要的具体头文件,避免不必要的编译依赖扩散。
- `Logger.h``Profiler.h` 中定义的重要宏分别是 `XE_LOG``XE_ASSERT``XE_PROFILE_BEGIN``XE_PROFILE_END``XE_PROFILE_FUNCTION`
## 声明概览
| 声明 | 类型 | 说明 |
|------|------|------|
| `Debug.h` | umbrella header | 调试模块的快速入口,而不是独立运行时对象。 |
## 相关文档
- [当前模块](../Debug.md)
- [Logger](../Logger/Logger.md)
- [Profiler](../Profiler/Profiler.md)
- [RenderDocCapture](../RenderDocCapture/RenderDocCapture.md)
- [Logging Architecture](../../../_guides/Debug/Logging-Architecture.md)

View File

@@ -1,13 +1,13 @@
# API 文档重构状态
**生成时间**: `2026-03-26 17:20:45`
**生成时间**: `2026-03-26 17:25:36`
**来源**: `docs/api/_tools/audit_api_docs.py`
## 摘要
- Markdown 页面数(全部): `2443`
- Markdown 页面数canonical: `2437`
- Markdown 页面数(全部): `2442`
- Markdown 页面数canonical: `2436`
- Public headers 数: `185`
- 有效头文件引用数(全部): `185`
- 有效头文件引用数canonical: `185`
@@ -45,7 +45,7 @@
| 字段 | 页面数 |
|------|--------|
| `命名空间` | `209` |
| `类型` | `209` |
| `描述` | `209` |
| `命名空间` | `208` |
| `类型` | `208` |
| `描述` | `208` |
| `头文件` | `185` |