docs: 重构 API 文档结构并修正源码准确性
- 重组文档目录结构: 每个模块的概述页移动到模块子目录 - 重命名 index.md 为 main.md - 修正所有模块文档中的错误: - math: FromEuler→FromEulerAngles, TransformDirection 包含缩放, Box 是 OBB, Color::ToRGBA 格式 - containers: 新增 operator==/!= 文档, 补充 std::hash DJB 算法细节 - core: 修复 types 链接错误 - debug: LogLevelToString 返回大写, timestamp 是秒, Profiler 空实现标注, Windows API vs ANSI - memory: 修复头文件路径, malloc vs operator new, 新增方法文档 - resources: 修复 Shader/Texture 链接错误 - threading: TaskSystem::Wait 空实现标注, ReadWriteLock 重入描述, LambdaTask 链接 - 验证: fix_links.py 确认 0 个断裂引用
This commit is contained in:
23
docs/api/debug/filelogsink/filelogsink.md
Normal file
23
docs/api/debug/filelogsink/filelogsink.md
Normal file
@@ -0,0 +1,23 @@
|
||||
# FileLogSink::FileLogSink
|
||||
|
||||
```cpp
|
||||
FileLogSink(const Containers::String& filePath)
|
||||
```
|
||||
|
||||
构造函数,打开指定路径的文件用于日志写入。如果文件已存在,则追加写入;如果不存在,则创建新文件。
|
||||
|
||||
**参数:**
|
||||
- `filePath` - 日志文件路径
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
auto fileSink = std::make_unique<XCEngine::Debug::FileLogSink>("logs/engine.log");
|
||||
XCEngine::Debug::Logger::Get().AddSink(std::move(fileSink));
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [FileLogSink 总览](filelogsink.md) - 返回类总览
|
||||
24
docs/api/debug/filelogsink/flush.md
Normal file
24
docs/api/debug/filelogsink/flush.md
Normal file
@@ -0,0 +1,24 @@
|
||||
# FileLogSink::Flush
|
||||
|
||||
```cpp
|
||||
void Flush() override
|
||||
```
|
||||
|
||||
刷新文件缓冲区,调用底层 `FileWriter` 的 flush 方法确保所有待写入的日志数据已实际写入磁盘。
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
auto fileSink = std::make_unique<XCEngine::Debug::FileLogSink>("logs/app.log");
|
||||
XCEngine::Debug::Logger::Get().AddSink(std::move(fileSink));
|
||||
// 关键操作后立即刷新
|
||||
XCEngine::Debug::Logger::Get().Info(XCEngine::Debug::LogCategory::General, "Checkpoint saved");
|
||||
// 确保写入磁盘
|
||||
XCEngine::Debug::Logger::Get().Flush();
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [FileLogSink 总览](filelogsink.md) - 返回类总览
|
||||
25
docs/api/debug/filelogsink/log.md
Normal file
25
docs/api/debug/filelogsink/log.md
Normal file
@@ -0,0 +1,25 @@
|
||||
# FileLogSink::Log
|
||||
|
||||
```cpp
|
||||
void Log(const LogEntry& entry) override
|
||||
```
|
||||
|
||||
将日志条目追加写入文件。根据 `LogEntry` 的各字段格式化日志行,包括时间戳、级别、分类、消息,并追加到文件末尾。
|
||||
|
||||
**参数:**
|
||||
- `entry` - 日志条目
|
||||
|
||||
**复杂度:** O(m),m 为消息长度
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
auto fileSink = std::make_unique<XCEngine::Debug::FileLogSink>("logs/app.log");
|
||||
XCEngine::Debug::Logger::Get().AddSink(std::move(fileSink));
|
||||
// Log 方法由 Logger 在内部调用
|
||||
XCEngine::Debug::Logger::Get().Error(XCEngine::Debug::LogCategory::FileSystem, "File not found");
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [FileLogSink 总览](filelogsink.md) - 返回类总览
|
||||
13
docs/api/debug/filelogsink/~filelogsink.md
Normal file
13
docs/api/debug/filelogsink/~filelogsink.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# FileLogSink::~FileLogSink
|
||||
|
||||
```cpp
|
||||
~FileLogSink() override
|
||||
```
|
||||
|
||||
析构函数。销毁 `FileLogSink` 实例,调用 `Flush()` 确保所有日志数据写入文件,然后关闭文件句柄。
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [FileLogSink 总览](filelogsink.md) - 返回类总览
|
||||
Reference in New Issue
Block a user