docs: rebuild Debug API content
This commit is contained in:
@@ -1,29 +1,34 @@
|
||||
# ConsoleLogSink::~ConsoleLogSink()
|
||||
# ConsoleLogSink::Destructor
|
||||
|
||||
销毁对象并释放相关资源。
|
||||
销毁控制台日志 sink。
|
||||
|
||||
```cpp
|
||||
~ConsoleLogSink() override;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Debug/ConsoleLogSink.h`,当前页面用于固定 `ConsoleLogSink` 类目录下的方法级 canonical 路径。
|
||||
## 行为说明
|
||||
|
||||
**参数:** 无。
|
||||
当前实现中的析构函数是默认实现,不负责关闭控制台或回收外部句柄。通常不需要直接调用它,而是让 `Logger` 在移除 sink 或 `Shutdown` 时通过 `ILogSink` 基类指针自动析构。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
## 参数
|
||||
|
||||
**示例:**
|
||||
- 无。
|
||||
|
||||
## 返回值
|
||||
|
||||
- 无。
|
||||
|
||||
## 线程语义
|
||||
|
||||
- 应在对象不再被其它线程使用时销毁。
|
||||
|
||||
## 示例
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Debug/ConsoleLogSink.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Debug::ConsoleLogSink object;
|
||||
// 对象离开作用域时会自动触发析构。
|
||||
}
|
||||
Logger::Get().Shutdown();
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](ConsoleLogSink.md)
|
||||
- [返回模块目录](../Debug.md)
|
||||
- [返回类型总览](ConsoleLogSink.md)
|
||||
- [ILogSink::Destructor](../ILogSink/Destructor.md)
|
||||
|
||||
Reference in New Issue
Block a user