docs: fix debug module documentation discrepancies

- Changed include path in debug.md from Logger.h to Debug.h (umbrella header)
- Added XE_ASSERT example in debug.md usage section
- Added documentation for Profiler private types (ProfileNode, ProfileSample)
- Added documentation for Profiler member variables (m_profileStack, m_samples, m_frameStartTime, m_initialized)
- Verified MarkEvent, SetMarker, ExportChromeTracing are correctly marked as stubs
This commit is contained in:
2026-03-19 01:02:15 +08:00
parent a669ec819d
commit 71413381af
2 changed files with 40 additions and 1 deletions

View File

@@ -59,7 +59,7 @@ Debug 模块提供了一套完整的调试工具,包括日志系统和性能
## 使用示例
```cpp
#include <XCEngine/Debug/Logger.h>
#include <XCEngine/Debug/Debug.h>
// 初始化日志系统
Logger::Get().Initialize();
@@ -76,6 +76,9 @@ XE_LOG(LogCategory::Rendering, LogLevel::Info, "Render started");
if (condition) {
XE_LOG(LogCategory::General, LogLevel::Error, "Something went wrong");
}
// 使用断言
XE_ASSERT(ptr != nullptr, "Pointer must not be null");
```
## 相关文档