docs: rebuild Debug API content
This commit is contained in:
@@ -1,30 +1,39 @@
|
||||
# Profiler::Initialize
|
||||
|
||||
初始化内部状态。
|
||||
把 `Profiler` 标记为已初始化。
|
||||
|
||||
```cpp
|
||||
void Initialize();
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Debug/Profiler.h`,当前页面用于固定 `Profiler` 类目录下的方法级 canonical 路径。
|
||||
## 行为说明
|
||||
|
||||
**参数:** 无。
|
||||
当前实现是幂等的:
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
- 如果已经初始化,直接返回。
|
||||
- 如果尚未初始化,仅把 `m_initialized` 设为 `true`。
|
||||
|
||||
**示例:**
|
||||
它不会分配新资源,也不会清理旧样本。更准确地说,当前 `Initialize` 只是一个状态标记,而不是完整自举流程。
|
||||
|
||||
## 参数
|
||||
|
||||
- 无。
|
||||
|
||||
## 返回值
|
||||
|
||||
- 无。
|
||||
|
||||
## 线程语义
|
||||
|
||||
- 当前没有同步逻辑;建议在单线程启动阶段调用。
|
||||
|
||||
## 示例
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Debug/Profiler.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Debug::Profiler object;
|
||||
// 根据上下文补齐参数后调用 Profiler::Initialize(...)。
|
||||
(void)object;
|
||||
}
|
||||
XCEngine::Debug::Profiler::Get().Initialize();
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](Profiler.md)
|
||||
- [返回模块目录](../Debug.md)
|
||||
- [返回类型总览](Profiler.md)
|
||||
- [Shutdown](Shutdown.md)
|
||||
|
||||
Reference in New Issue
Block a user