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:
32
docs/api/debug/ilogsink/flush.md
Normal file
32
docs/api/debug/ilogsink/flush.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# ILogSink::Flush
|
||||
|
||||
```cpp
|
||||
virtual void Flush() = 0
|
||||
```
|
||||
|
||||
刷新输出缓冲区,确保所有待写入的日志数据已实际写入目标介质。对于文件类 Sink,应调用底层文件系统的 flush;对于网络类 Sink,应发送缓冲区中的数据。
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
class BufferedLogSink : public XCEngine::Debug::ILogSink {
|
||||
private:
|
||||
std::string m_buffer;
|
||||
public:
|
||||
void Log(const XCEngine::Debug::LogEntry& entry) override {
|
||||
m_buffer += entry.message.CStr();
|
||||
m_buffer += "\n";
|
||||
}
|
||||
void Flush() override {
|
||||
// 将缓冲区数据写入目标
|
||||
writeToDestination(m_buffer);
|
||||
m_buffer.clear();
|
||||
}
|
||||
};
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [ILogSink 总览](ilogsink.md) - 返回类总览
|
||||
45
docs/api/debug/ilogsink/ilogsink.md
Normal file
45
docs/api/debug/ilogsink/ilogsink.md
Normal file
@@ -0,0 +1,45 @@
|
||||
# ILogSink
|
||||
|
||||
**命名空间**: `XCEngine::Debug`
|
||||
|
||||
**类型**: `class` (abstract interface)
|
||||
|
||||
**描述**: 日志输出槽抽象接口,定义日志输出的标准协议。
|
||||
|
||||
## 概述
|
||||
|
||||
`ILogSink` 是日志系统的输出抽象接口。用户可以实现此接口来创建自定义的日志输出方式,如网络输出、数据库存储等。`Logger` 通过多个 Sink 分发日志。
|
||||
|
||||
## 公共方法
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| `virtual void Log(const LogEntry& entry) = 0` | [输出单条日志](log.md) |
|
||||
| `virtual void Flush() = 0` | [刷新缓冲区,确保日志写入](flush.md) |
|
||||
|
||||
## 使用示例
|
||||
|
||||
```cpp
|
||||
class CustomLogSink : public ILogSink {
|
||||
public:
|
||||
void Log(const LogEntry& entry) override {
|
||||
printf("[%s] %s: %s\n",
|
||||
LogLevelToString(entry.level),
|
||||
LogCategoryToString(entry.category),
|
||||
entry.message.CStr());
|
||||
}
|
||||
|
||||
void Flush() override {
|
||||
fflush(stdout);
|
||||
}
|
||||
};
|
||||
|
||||
Logger::Get().AddSink(std::make_unique<CustomLogSink>());
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [Debug 模块总览](../debug.md) - 返回模块总览
|
||||
- [Logger](../logger/logger.md) - 日志记录器
|
||||
- [ConsoleLogSink](../consolelogsink/consolelogsink.md) - 控制台输出
|
||||
- [FileLogSink](../filelogsink/filelogsink.md) - 文件输出
|
||||
29
docs/api/debug/ilogsink/log.md
Normal file
29
docs/api/debug/ilogsink/log.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# ILogSink::Log
|
||||
|
||||
```cpp
|
||||
virtual void Log(const LogEntry& entry) = 0
|
||||
```
|
||||
|
||||
输出单条日志到目标介质。`Logger` 在每次日志记录时调用此方法,将包含完整日志信息的 `LogEntry` 传入。派生类需要实现具体的输出逻辑。
|
||||
|
||||
**参数:**
|
||||
- `entry` - 日志条目,包含级别、分类、消息、时间戳、线程 ID 等完整信息
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
class NetworkLogSink : public XCEngine::Debug::ILogSink {
|
||||
public:
|
||||
void Log(const XCEngine::Debug::LogEntry& entry) override {
|
||||
// 将日志发送到远程服务器
|
||||
sendToServer(entry.message.CStr());
|
||||
}
|
||||
void Flush() override { }
|
||||
};
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [ILogSink 总览](ilogsink.md) - 返回类总览
|
||||
Reference in New Issue
Block a user