From de4086dbfee4cfce9fcd0aeaa62490f389447ac5 Mon Sep 17 00:00:00 2001
From: ssdfasd <2156608475@qq.com>
Date: Thu, 19 Mar 2026 01:04:30 +0800
Subject: [PATCH] docs: Fix core module documentation discrepancies

Fixed the following issues in XCEngine Core module documentation:
- Added 'using namespace XCEngine::Core;' to all code examples that use
  Core types (Event, FileWriter, etc.) without full namespace qualification
- Added missing '#include <XCEngine/Containers/String.h>' to FileWriter
  examples that use Containers::String
- Added '#include <string>' to Flush.md example using std::to_string

Affected files:
- core/core.md: Added using directive and Containers include
- event/*.md: Added using namespace to all 8 event doc files
- filewriter/*.md: Added using namespace and proper includes to all 6 files
---
 docs/api/core/core.md                      | 7 +++++--
 docs/api/core/event/Clear.md               | 2 ++
 docs/api/core/event/Invoke.md              | 2 ++
 docs/api/core/event/ProcessUnsubscribes.md | 2 ++
 docs/api/core/event/Subscribe.md           | 2 ++
 docs/api/core/event/Unsubscribe.md         | 2 ++
 docs/api/core/event/begin.md               | 2 ++
 docs/api/core/event/end.md                 | 2 ++
 docs/api/core/event/event.md               | 4 ++++
 docs/api/core/filewriter/Close.md          | 2 ++
 docs/api/core/filewriter/Flush.md          | 3 +++
 docs/api/core/filewriter/IsOpen.md         | 2 ++
 docs/api/core/filewriter/Open.md           | 2 ++
 docs/api/core/filewriter/Write.md          | 2 ++
 docs/api/core/filewriter/filewriter.md     | 3 +++
 15 files changed, 37 insertions(+), 2 deletions(-)

diff --git a/docs/api/core/core.md b/docs/api/core/core.md
index 026effff..03239b3f 100644
--- a/docs/api/core/core.md
+++ b/docs/api/core/core.md
@@ -71,10 +71,13 @@ UniqueRef<T> MakeUnique(Args&&... args);
 
 ```cpp
 #include <XCEngine/Core/Core.h>
+#include <XCEngine/Containers/String.h>
+
+using namespace XCEngine::Core;
 
 // 使用类型别名
-Core::uint32 value = 100;
-Core::byte data[4];
+uint32 value = 100;
+byte data[4];
 
 // 使用智能指针
 auto ref = MakeRef<MyClass>();
diff --git a/docs/api/core/event/Clear.md b/docs/api/core/event/Clear.md
index 51affc0d..3d49bf9c 100644
--- a/docs/api/core/event/Clear.md
+++ b/docs/api/core/event/Clear.md
@@ -17,6 +17,8 @@ void Clear();
 ```cpp
 #include <XCEngine/Core/Event.h>
 
+using namespace XCEngine::Core;
+
 Event<int> event;
 
 // 订阅多个回调
diff --git a/docs/api/core/event/Invoke.md b/docs/api/core/event/Invoke.md
index 51936ce2..1cd708a0 100644
--- a/docs/api/core/event/Invoke.md
+++ b/docs/api/core/event/Invoke.md
@@ -20,6 +20,8 @@ void Invoke(Args... args);
 ```cpp
 #include <XCEngine/Core/Event.h>
 
+using namespace XCEngine::Core;
+
 // 无参数事件
 Event<> frameEndEvent;
 frameEndEvent.Subscribe([]() {
diff --git a/docs/api/core/event/ProcessUnsubscribes.md b/docs/api/core/event/ProcessUnsubscribes.md
index fdca8fc9..32bcbf78 100644
--- a/docs/api/core/event/ProcessUnsubscribes.md
+++ b/docs/api/core/event/ProcessUnsubscribes.md
@@ -17,6 +17,8 @@ void ProcessUnsubscribes();
 ```cpp
 #include <XCEngine/Core/Event.h>
 
+using namespace XCEngine::Core;
+
 Event<int> event;
 
 // 订阅
diff --git a/docs/api/core/event/Subscribe.md b/docs/api/core/event/Subscribe.md
index 85b79400..6f961f5b 100644
--- a/docs/api/core/event/Subscribe.md
+++ b/docs/api/core/event/Subscribe.md
@@ -22,6 +22,8 @@ uint64_t Subscribe(Callback callback);
 ```cpp
 #include <XCEngine/Core/Event.h>
 
+using namespace XCEngine::Core;
+
 // 定义事件
 Event<int, float> damageEvent;
 
diff --git a/docs/api/core/event/Unsubscribe.md b/docs/api/core/event/Unsubscribe.md
index 78411391..821b4de6 100644
--- a/docs/api/core/event/Unsubscribe.md
+++ b/docs/api/core/event/Unsubscribe.md
@@ -20,6 +20,8 @@ void Unsubscribe(uint64_t id);
 ```cpp
 #include <XCEngine/Core/Event.h>
 
+using namespace XCEngine::Core;
+
 Event<int> someEvent;
 
 // 订阅
diff --git a/docs/api/core/event/begin.md b/docs/api/core/event/begin.md
index 7f06f209..4337dcc5 100644
--- a/docs/api/core/event/begin.md
+++ b/docs/api/core/event/begin.md
@@ -19,6 +19,8 @@ Iterator begin();
 ```cpp
 #include <XCEngine/Core/Event.h>
 
+using namespace XCEngine::Core;
+
 Event<int> event;
 event.Subscribe([](int v) { printf("Callback 1: %d\n", v); });
 event.Subscribe([](int v) { printf("Callback 2: %d\n", v); });
diff --git a/docs/api/core/event/end.md b/docs/api/core/event/end.md
index 47bf34e7..cbbf5d35 100644
--- a/docs/api/core/event/end.md
+++ b/docs/api/core/event/end.md
@@ -19,6 +19,8 @@ Iterator end();
 ```cpp
 #include <XCEngine/Core/Event.h>
 
+using namespace XCEngine::Core;
+
 Event<int> event;
 event.Subscribe([](int v) { printf("Callback: %d\n", v); });
 
diff --git a/docs/api/core/event/event.md b/docs/api/core/event/event.md
index 22ebc699..decd36c1 100644
--- a/docs/api/core/event/event.md
+++ b/docs/api/core/event/event.md
@@ -63,6 +63,10 @@
 ## 使用示例
 
 ```cpp
+#include <XCEngine/Core/Event.h>
+
+using namespace XCEngine::Core;
+
 // 定义事件（无参数）
 Event<> frameStartEvent;
 
diff --git a/docs/api/core/filewriter/Close.md b/docs/api/core/filewriter/Close.md
index e3458c7b..85350fe9 100644
--- a/docs/api/core/filewriter/Close.md
+++ b/docs/api/core/filewriter/Close.md
@@ -17,6 +17,8 @@ void Close();
 ```cpp
 #include <XCEngine/Core/FileWriter.h>
 
+using namespace XCEngine::Core;
+
 FileWriter writer;
 
 if (writer.Open("data.txt")) {
diff --git a/docs/api/core/filewriter/Flush.md b/docs/api/core/filewriter/Flush.md
index d93fdec1..e1326091 100644
--- a/docs/api/core/filewriter/Flush.md
+++ b/docs/api/core/filewriter/Flush.md
@@ -18,6 +18,9 @@ bool Flush();
 
 ```cpp
 #include <XCEngine/Core/FileWriter.h>
+#include <string>
+
+using namespace XCEngine::Core;
 
 FileWriter writer("output.txt");
 if (writer.IsOpen()) {
diff --git a/docs/api/core/filewriter/IsOpen.md b/docs/api/core/filewriter/IsOpen.md
index 6280eb3b..63957437 100644
--- a/docs/api/core/filewriter/IsOpen.md
+++ b/docs/api/core/filewriter/IsOpen.md
@@ -19,6 +19,8 @@ bool IsOpen() const;
 ```cpp
 #include <XCEngine/Core/FileWriter.h>
 
+using namespace XCEngine::Core;
+
 FileWriter writer1;
 if (writer1.IsOpen()) {
     // 不会执行
diff --git a/docs/api/core/filewriter/Open.md b/docs/api/core/filewriter/Open.md
index 3ecae4e8..d572e394 100644
--- a/docs/api/core/filewriter/Open.md
+++ b/docs/api/core/filewriter/Open.md
@@ -23,6 +23,8 @@ bool Open(const char* filePath, bool append = false);
 ```cpp
 #include <XCEngine/Core/FileWriter.h>
 
+using namespace XCEngine::Core;
+
 FileWriter writer;
 
 // 打开文件（覆盖模式）
diff --git a/docs/api/core/filewriter/Write.md b/docs/api/core/filewriter/Write.md
index 1ffe2221..ce47d085 100644
--- a/docs/api/core/filewriter/Write.md
+++ b/docs/api/core/filewriter/Write.md
@@ -26,6 +26,8 @@ bool Write(const Containers::String& str);
 #include <XCEngine/Core/FileWriter.h>
 #include <XCEngine/Containers/String.h>
 
+using namespace XCEngine::Core;
+
 FileWriter writer("output.txt");
 if (writer.IsOpen()) {
     // 写入原始字符数组
diff --git a/docs/api/core/filewriter/filewriter.md b/docs/api/core/filewriter/filewriter.md
index dde20fb4..77968956 100644
--- a/docs/api/core/filewriter/filewriter.md
+++ b/docs/api/core/filewriter/filewriter.md
@@ -51,6 +51,9 @@
 
 ```cpp
 #include <XCEngine/Core/FileWriter.h>
+#include <XCEngine/Containers/String.h>
+
+using namespace XCEngine::Core;
 
 // 方式1：构造时打开
 FileWriter writer("output.txt", false);