From dae1a63a90d78dfdfa544907422fddb0b7e3a9b8 Mon Sep 17 00:00:00 2001 From: ssdfasd <2156608475@qq.com> Date: Thu, 19 Mar 2026 00:47:29 +0800 Subject: [PATCH] Fix debug module documentation discrepancies - Fix XE_LOG macro parameter order in debug.md (category, level) was reversed - Add 'Implementation Status' section to profiler.md listing stub methods (MarkEvent, SetMarker, ExportChromeTracing) that are not yet implemented --- docs/api/debug/debug.md | 4 ++-- docs/api/debug/profiler/profiler.md | 10 ++++++++++ 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/docs/api/debug/debug.md b/docs/api/debug/debug.md index deaefe0a..a5823a54 100644 --- a/docs/api/debug/debug.md +++ b/docs/api/debug/debug.md @@ -70,11 +70,11 @@ Logger::Get().AddSink(std::make_unique("app.log")); Logger::Get().SetMinimumLevel(LogLevel::Debug); // 记录日志 -XE_LOG(LogLevel::Info, LogCategory::Rendering, "Render started"); +XE_LOG(LogCategory::Rendering, LogLevel::Info, "Render started"); // 使用宏记录日志 if (condition) { - XE_LOG(LogLevel::Error, LogCategory::General, "Something went wrong"); + XE_LOG(LogCategory::General, LogLevel::Error, "Something went wrong"); } ``` diff --git a/docs/api/debug/profiler/profiler.md b/docs/api/debug/profiler/profiler.md index 50469d7a..53dc2b16 100644 --- a/docs/api/debug/profiler/profiler.md +++ b/docs/api/debug/profiler/profiler.md @@ -78,6 +78,16 @@ 自动使用当前函数名进行分析。 +## 实现状态 + +以下方法目前为存根(stub)实现,尚未完成功能: + +| 方法 | 状态 | +|------|------| +| `void MarkEvent(const char* name, uint64_t timestamp, uint32_t threadId)` | 存根 | +| `void SetMarker(const char* name, uint32_t color)` | 存根 | +| `void ExportChromeTracing(const Containers::String& filePath)` | 存根 | + ## 使用示例 ```cpp