docs: rebuild Debug API content
This commit is contained in:
@@ -1,30 +1,35 @@
|
||||
# ConsoleLogSink::Flush
|
||||
|
||||
公开方法,详见头文件声明。
|
||||
刷新标准输出流,确保之前写入的控制台文本立即可见。
|
||||
|
||||
```cpp
|
||||
void Flush() override;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Debug/ConsoleLogSink.h`,当前页面用于固定 `ConsoleLogSink` 类目录下的方法级 canonical 路径。
|
||||
## 行为说明
|
||||
|
||||
**参数:** 无。
|
||||
当前实现直接调用 `fflush(stdout)`。如果你依赖实时控制台输出,例如在崩溃前或长帧分析时,希望日志立刻出现,可以显式调用该方法。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
## 参数
|
||||
|
||||
**示例:**
|
||||
- 无。
|
||||
|
||||
## 返回值
|
||||
|
||||
- 无。
|
||||
|
||||
## 线程语义
|
||||
|
||||
- `ConsoleLogSink` 自身不加锁;通常通过 `Logger` 串行调用。
|
||||
|
||||
## 示例
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Debug/ConsoleLogSink.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Debug::ConsoleLogSink object;
|
||||
// 根据上下文补齐参数后调用 ConsoleLogSink::Flush(...)。
|
||||
(void)object;
|
||||
}
|
||||
ConsoleLogSink sink;
|
||||
sink.Flush();
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](ConsoleLogSink.md)
|
||||
- [返回模块目录](../Debug.md)
|
||||
- [返回类型总览](ConsoleLogSink.md)
|
||||
- [Log](Log.md)
|
||||
|
||||
Reference in New Issue
Block a user