docs: rebuild Debug API content
This commit is contained in:
@@ -1,29 +1,36 @@
|
||||
# FileLogSink::FileLogSink()
|
||||
# FileLogSink::Constructor
|
||||
|
||||
构造对象。
|
||||
构造一个把日志追加写入文件的 sink。
|
||||
|
||||
```cpp
|
||||
FileLogSink(const Containers::String& filePath);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Debug/FileLogSink.h`,当前页面用于固定 `FileLogSink` 类目录下的方法级 canonical 路径。
|
||||
## 行为说明
|
||||
|
||||
**参数:**
|
||||
- `filePath` - 参数语义详见头文件声明。
|
||||
当前实现会保存 `filePath`,并立即尝试通过 `Core::FileWriter` 以追加模式打开该文件。即使第一次打开失败,对象仍然会保留路径,后续在 `Log` 时继续重试打开。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
## 参数
|
||||
|
||||
**示例:**
|
||||
- `filePath` - 日志文件路径。
|
||||
|
||||
## 返回值
|
||||
|
||||
- 无。
|
||||
|
||||
## 线程语义
|
||||
|
||||
- 构造本身不加锁;通常在启动阶段创建并交给 `Logger` 持有。
|
||||
|
||||
## 示例
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Debug/FileLogSink.h>
|
||||
using namespace XCEngine::Debug;
|
||||
|
||||
void Example() {
|
||||
XCEngine::Debug::FileLogSink object;
|
||||
}
|
||||
Logger::Get().AddSink(std::make_unique<FileLogSink>("editor.log"));
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](FileLogSink.md)
|
||||
- [返回模块目录](../Debug.md)
|
||||
- [返回类型总览](FileLogSink.md)
|
||||
- [Log](Log.md)
|
||||
|
||||
Reference in New Issue
Block a user