docs: rebuild Memory API content
This commit is contained in:
@@ -1,30 +1,26 @@
|
||||
# MemoryManager::DumpMemoryLeaks
|
||||
|
||||
公开方法,详见头文件声明。
|
||||
输出内存泄漏报告。
|
||||
|
||||
```cpp
|
||||
void DumpMemoryLeaks();
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Memory/MemoryManager.h`,当前页面用于固定 `MemoryManager` 类目录下的方法级 canonical 路径。
|
||||
## 行为说明
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
当前实现还只是占位接口,实际只向标准输出打印一行标题:
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Memory/MemoryManager.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Memory::MemoryManager object;
|
||||
// 根据上下文补齐参数后调用 MemoryManager::DumpMemoryLeaks(...)。
|
||||
(void)object;
|
||||
}
|
||||
Memory Leak Report:
|
||||
```
|
||||
|
||||
它不会遍历任何分配记录,也不会列出真实泄漏条目。
|
||||
|
||||
## 返回值
|
||||
|
||||
- 无。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](MemoryManager.md)
|
||||
- [返回模块目录](../Memory.md)
|
||||
- [返回类型总览](MemoryManager.md)
|
||||
- [GenerateMemoryReport](GenerateMemoryReport.md)
|
||||
|
||||
Reference in New Issue
Block a user