docs: rebuild Debug API content
This commit is contained in:
@@ -1,31 +1,36 @@
|
||||
# Profiler::ExportChromeTracing
|
||||
|
||||
公开方法,详见头文件声明。
|
||||
将采样结果导出为 Chrome Tracing 格式文件。
|
||||
|
||||
```cpp
|
||||
void ExportChromeTracing(const Containers::String& filePath);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Debug/Profiler.h`,当前页面用于固定 `Profiler` 类目录下的方法级 canonical 路径。
|
||||
## 行为说明
|
||||
|
||||
**参数:**
|
||||
- `filePath` - 参数语义详见头文件声明。
|
||||
当前实现是空函数,不会创建文件,也不会导出任何样本。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
从 API 形状可以推断,这个接口是为后续接入 Chrome Trace 或 Perfetto 类工具预留的;但在当前版本中,调用它不会产生可见效果。
|
||||
|
||||
**示例:**
|
||||
## 参数
|
||||
|
||||
- `filePath` - 预期的输出文件路径。当前实现不会实际使用该参数。
|
||||
|
||||
## 返回值
|
||||
|
||||
- 无。
|
||||
|
||||
## 线程语义
|
||||
|
||||
- 当前为空实现,无额外线程语义。
|
||||
|
||||
## 示例
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Debug/Profiler.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Debug::Profiler object;
|
||||
// 根据上下文补齐参数后调用 Profiler::ExportChromeTracing(...)。
|
||||
(void)object;
|
||||
}
|
||||
XCEngine::Debug::Profiler::Get().ExportChromeTracing("trace.json");
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](Profiler.md)
|
||||
- [返回模块目录](../Debug.md)
|
||||
- [返回类型总览](Profiler.md)
|
||||
- [Profiler Workflow](../../../_guides/Debug/Profiler-Workflow.md)
|
||||
|
||||
Reference in New Issue
Block a user