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:
20
docs/api/debug/consolelogsink/consolelogsink.md
Normal file
20
docs/api/debug/consolelogsink/consolelogsink.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# ConsoleLogSink::ConsoleLogSink
|
||||
|
||||
```cpp
|
||||
ConsoleLogSink()
|
||||
```
|
||||
|
||||
默认构造函数。创建一个 `ConsoleLogSink` 实例,默认启用彩色输出,最小日志级别为 `Verbose`。
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
auto sink = std::make_unique<XCEngine::Debug::ConsoleLogSink>();
|
||||
XCEngine::Debug::Logger::Get().AddSink(std::move(sink));
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [ConsoleLogSink 总览](consolelogsink.md) - 返回类总览
|
||||
22
docs/api/debug/consolelogsink/flush.md
Normal file
22
docs/api/debug/consolelogsink/flush.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# ConsoleLogSink::Flush
|
||||
|
||||
```cpp
|
||||
void Flush() override
|
||||
```
|
||||
|
||||
刷新标准输出流(stdout),调用 `fflush(stdout)` 确保所有待输出的日志内容立即显示在控制台上。
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
auto sink = std::make_unique<XCEngine::Debug::ConsoleLogSink>();
|
||||
XCEngine::Debug::Logger::Get().AddSink(std::move(sink));
|
||||
// 在程序异常退出前确保日志已输出
|
||||
XCEngine::Debug::Logger::Get().Flush();
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [ConsoleLogSink 总览](consolelogsink.md) - 返回类总览
|
||||
25
docs/api/debug/consolelogsink/log.md
Normal file
25
docs/api/debug/consolelogsink/log.md
Normal file
@@ -0,0 +1,25 @@
|
||||
# ConsoleLogSink::Log
|
||||
|
||||
```cpp
|
||||
void Log(const LogEntry& entry) override
|
||||
```
|
||||
|
||||
将日志输出到控制台。根据 `LogEntry` 的级别和分类格式化输出内容,并根据 `m_colorOutput` 设置决定是否使用 Windows 控制台颜色 API。如果日志级别低于设置的最小级别,则不输出。
|
||||
|
||||
**参数:**
|
||||
- `entry` - 日志条目
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
auto sink = std::make_unique<XCEngine::Debug::ConsoleLogSink>();
|
||||
// Log 方法由 Logger 在内部调用,用户无需直接调用
|
||||
XCEngine::Debug::Logger::Get().AddSink(std::move(sink));
|
||||
XCEngine::Debug::Logger::Get().Info(XCEngine::Debug::LogCategory::General, "Hello console");
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [ConsoleLogSink 总览](consolelogsink.md) - 返回类总览
|
||||
24
docs/api/debug/consolelogsink/setcoloroutput.md
Normal file
24
docs/api/debug/consolelogsink/setcoloroutput.md
Normal file
@@ -0,0 +1,24 @@
|
||||
# ConsoleLogSink::SetColorOutput
|
||||
|
||||
```cpp
|
||||
void SetColorOutput(bool enable)
|
||||
```
|
||||
|
||||
启用或禁用控制台彩色输出。启用后,不同日志级别使用 Windows 控制台颜色 API 输出,便于快速区分日志类型。
|
||||
|
||||
**参数:**
|
||||
- `enable` - true 启用彩色输出,false 禁用
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
auto sink = std::make_unique<XCEngine::Debug::ConsoleLogSink>();
|
||||
sink->SetColorOutput(false); // 禁用颜色(适合日志文件或 CI 环境)
|
||||
XCEngine::Debug::Logger::Get().AddSink(std::move(sink));
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [ConsoleLogSink 总览](consolelogsink.md) - 返回类总览
|
||||
24
docs/api/debug/consolelogsink/setminimumlevel.md
Normal file
24
docs/api/debug/consolelogsink/setminimumlevel.md
Normal file
@@ -0,0 +1,24 @@
|
||||
# ConsoleLogSink::SetMinimumLevel
|
||||
|
||||
```cpp
|
||||
void SetMinimumLevel(LogLevel level)
|
||||
```
|
||||
|
||||
设置该 Sink 的最小输出级别。此设置仅影响当前 Sink,不会影响 Logger 的全局级别过滤。
|
||||
|
||||
**参数:**
|
||||
- `level` - 最小日志级别
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
auto sink = std::make_unique<XCEngine::Debug::ConsoleLogSink>();
|
||||
sink->SetMinimumLevel(XCEngine::Debug::LogLevel::Warning); // 控制台只显示警告及以上
|
||||
XCEngine::Debug::Logger::Get().AddSink(std::move(sink));
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [ConsoleLogSink 总览](consolelogsink.md) - 返回类总览
|
||||
13
docs/api/debug/consolelogsink/~consolelogsink.md
Normal file
13
docs/api/debug/consolelogsink/~consolelogsink.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# ConsoleLogSink::~ConsoleLogSink
|
||||
|
||||
```cpp
|
||||
~ConsoleLogSink() override
|
||||
```
|
||||
|
||||
析构函数。销毁 `ConsoleLogSink` 实例,释放相关资源。
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [ConsoleLogSink 总览](consolelogsink.md) - 返回类总览
|
||||
Reference in New Issue
Block a user