docs: rebuild Debug API content

This commit is contained in:
2026-03-26 17:21:44 +08:00
parent 122495e581
commit 2e2316aa55
69 changed files with 2371 additions and 1092 deletions

View File

@@ -1,30 +1,40 @@
# Profiler::Shutdown
关闭并清理内部状态。
清空 profiler 内部状态。
```cpp
void Shutdown();
```
该方法声明于 `XCEngine/Debug/Profiler.h`,当前页面用于固定 `Profiler` 类目录下的方法级 canonical 路径。
## 行为说明
**参数:** 无。
当前实现会:
**返回:** `void` - 无返回值。
- 清空 `m_samples`
- 清空 `m_profileStack`
-`m_initialized` 设为 `false`
**示例:**
它不会导出当前样本,也不会保留历史结果。
## 参数
- 无。
## 返回值
- 无。
## 线程语义
- 应在不再有 profile 区段写入时调用。
## 示例
```cpp
#include <XCEngine/Debug/Profiler.h>
void Example() {
XCEngine::Debug::Profiler object;
// 根据上下文补齐参数后调用 Profiler::Shutdown(...)。
(void)object;
}
XCEngine::Debug::Profiler::Get().Shutdown();
```
## 相关文档
- [返回类总览](Profiler.md)
- [返回模块目录](../Debug.md)
- [返回类总览](Profiler.md)
- [Initialize](Initialize.md)