docs: rebuild Debug API content
This commit is contained in:
@@ -1,29 +1,35 @@
|
||||
# ILogSink::~ILogSink()
|
||||
# ILogSink::Destructor
|
||||
|
||||
销毁对象并释放相关资源。
|
||||
以基类指针安全销毁日志 sink。
|
||||
|
||||
```cpp
|
||||
virtual ~ILogSink() = default;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Debug/ILogSink.h`,当前页面用于固定 `ILogSink` 类目录下的方法级 canonical 路径。
|
||||
## 行为说明
|
||||
|
||||
**参数:** 无。
|
||||
这是一个虚析构函数,目的是保证 `Logger` 通过 `std::unique_ptr<ILogSink>` 释放派生类对象时,能够正确调用派生类析构逻辑。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
## 参数
|
||||
|
||||
**示例:**
|
||||
- 无。
|
||||
|
||||
## 返回值
|
||||
|
||||
- 无。
|
||||
|
||||
## 线程语义
|
||||
|
||||
- 销毁前应确保对象不再被并发调用。
|
||||
|
||||
## 示例
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Debug/ILogSink.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Debug::ILogSink object;
|
||||
// 对象离开作用域时会自动触发析构。
|
||||
}
|
||||
XCEngine::Debug::Logger::Get().Shutdown();
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](ILogSink.md)
|
||||
- [返回模块目录](../Debug.md)
|
||||
- [返回类型总览](ILogSink.md)
|
||||
- [ConsoleLogSink::Destructor](../ConsoleLogSink/Destructor.md)
|
||||
- [FileLogSink::Destructor](../FileLogSink/Destructor.md)
|
||||
|
||||
Reference in New Issue
Block a user