docs: rebuild Debug API content
This commit is contained in:
@@ -1,29 +1,34 @@
|
||||
# FileLogSink::~FileLogSink()
|
||||
# FileLogSink::Destructor
|
||||
|
||||
销毁对象并释放相关资源。
|
||||
销毁文件日志 sink 并关闭底层文件。
|
||||
|
||||
```cpp
|
||||
~FileLogSink() override;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Debug/FileLogSink.h`,当前页面用于固定 `FileLogSink` 类目录下的方法级 canonical 路径。
|
||||
## 行为说明
|
||||
|
||||
**参数:** 无。
|
||||
当前实现直接调用 `m_writer.Close()`。如果该 sink 仍由 `Logger` 持有,通常会在 `Logger::Shutdown` 清空 sink 列表时自动触发析构。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
## 参数
|
||||
|
||||
**示例:**
|
||||
- 无。
|
||||
|
||||
## 返回值
|
||||
|
||||
- 无。
|
||||
|
||||
## 线程语义
|
||||
|
||||
- 应在对象不再参与日志分发后销毁。
|
||||
|
||||
## 示例
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Debug/FileLogSink.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Debug::FileLogSink object;
|
||||
// 对象离开作用域时会自动触发析构。
|
||||
}
|
||||
XCEngine::Debug::Logger::Get().Shutdown();
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](FileLogSink.md)
|
||||
- [返回模块目录](../Debug.md)
|
||||
- [返回类型总览](FileLogSink.md)
|
||||
- [ILogSink::Destructor](../ILogSink/Destructor.md)
|
||||
|
||||
Reference in New Issue
Block a user