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
This commit is contained in:
@@ -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>();
|
||||
|
||||
@@ -17,6 +17,8 @@ void Clear();
|
||||
```cpp
|
||||
#include <XCEngine/Core/Event.h>
|
||||
|
||||
using namespace XCEngine::Core;
|
||||
|
||||
Event<int> event;
|
||||
|
||||
// 订阅多个回调
|
||||
|
||||
@@ -20,6 +20,8 @@ void Invoke(Args... args);
|
||||
```cpp
|
||||
#include <XCEngine/Core/Event.h>
|
||||
|
||||
using namespace XCEngine::Core;
|
||||
|
||||
// 无参数事件
|
||||
Event<> frameEndEvent;
|
||||
frameEndEvent.Subscribe([]() {
|
||||
|
||||
@@ -17,6 +17,8 @@ void ProcessUnsubscribes();
|
||||
```cpp
|
||||
#include <XCEngine/Core/Event.h>
|
||||
|
||||
using namespace XCEngine::Core;
|
||||
|
||||
Event<int> event;
|
||||
|
||||
// 订阅
|
||||
|
||||
@@ -22,6 +22,8 @@ uint64_t Subscribe(Callback callback);
|
||||
```cpp
|
||||
#include <XCEngine/Core/Event.h>
|
||||
|
||||
using namespace XCEngine::Core;
|
||||
|
||||
// 定义事件
|
||||
Event<int, float> damageEvent;
|
||||
|
||||
|
||||
@@ -20,6 +20,8 @@ void Unsubscribe(uint64_t id);
|
||||
```cpp
|
||||
#include <XCEngine/Core/Event.h>
|
||||
|
||||
using namespace XCEngine::Core;
|
||||
|
||||
Event<int> someEvent;
|
||||
|
||||
// 订阅
|
||||
|
||||
@@ -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); });
|
||||
|
||||
@@ -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); });
|
||||
|
||||
|
||||
@@ -63,6 +63,10 @@
|
||||
## 使用示例
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Core/Event.h>
|
||||
|
||||
using namespace XCEngine::Core;
|
||||
|
||||
// 定义事件(无参数)
|
||||
Event<> frameStartEvent;
|
||||
|
||||
|
||||
@@ -17,6 +17,8 @@ void Close();
|
||||
```cpp
|
||||
#include <XCEngine/Core/FileWriter.h>
|
||||
|
||||
using namespace XCEngine::Core;
|
||||
|
||||
FileWriter writer;
|
||||
|
||||
if (writer.Open("data.txt")) {
|
||||
|
||||
@@ -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()) {
|
||||
|
||||
@@ -19,6 +19,8 @@ bool IsOpen() const;
|
||||
```cpp
|
||||
#include <XCEngine/Core/FileWriter.h>
|
||||
|
||||
using namespace XCEngine::Core;
|
||||
|
||||
FileWriter writer1;
|
||||
if (writer1.IsOpen()) {
|
||||
// 不会执行
|
||||
|
||||
@@ -23,6 +23,8 @@ bool Open(const char* filePath, bool append = false);
|
||||
```cpp
|
||||
#include <XCEngine/Core/FileWriter.h>
|
||||
|
||||
using namespace XCEngine::Core;
|
||||
|
||||
FileWriter writer;
|
||||
|
||||
// 打开文件(覆盖模式)
|
||||
|
||||
@@ -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()) {
|
||||
// 写入原始字符数组
|
||||
|
||||
@@ -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);
|
||||
|
||||
Reference in New Issue
Block a user