docs: Fix SKILL.md规范 violations - Remove ## 方法列表 and flatten ### sub-headers in ## 公共方法
This commit is contained in:
@@ -26,39 +26,15 @@
|
||||
|
||||
## 公共方法
|
||||
|
||||
### 订阅/退订
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| `uint64_t Subscribe(Callback callback)` | 订阅事件,返回订阅 ID |
|
||||
| `void Unsubscribe(uint64_t id)` | 退订事件(延迟生效) |
|
||||
| `void ProcessUnsubscribes()` | 处理积压的退订请求 |
|
||||
| `void Clear()` | 清空所有订阅 |
|
||||
|
||||
### 调用
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| `void Invoke(Args... args)` | 调用所有订阅的回调 |
|
||||
|
||||
### 迭代
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| `Iterator begin()` | 获取开始迭代器 |
|
||||
| `Iterator end()` | 获取结束迭代器 |
|
||||
|
||||
## 方法列表
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [Subscribe](Subscribe.md) | 订阅事件回调 |
|
||||
| [Unsubscribe](Unsubscribe.md) | 退订事件 |
|
||||
| [ProcessUnsubscribes](ProcessUnsubscribes.md) | 处理积压的退订请求 |
|
||||
| [Invoke](Invoke.md) | 调用所有订阅的回调 |
|
||||
| [Clear](Clear.md) | 清空所有订阅 |
|
||||
| [begin](begin.md) | 获取开始迭代器 |
|
||||
| [end](end.md) | 获取结束迭代器 |
|
||||
| [`Subscribe`](Subscribe.md) | 订阅事件回调,返回订阅 ID |
|
||||
| [`Unsubscribe`](Unsubscribe.md) | 退订事件(延迟生效) |
|
||||
| [`ProcessUnsubscribes`](ProcessUnsubscribes.md) | 处理积压的退订请求 |
|
||||
| [`Clear`](Clear.md) | 清空所有订阅 |
|
||||
| [`Invoke`](Invoke.md) | 调用所有订阅的回调 |
|
||||
| [`begin`](begin.md) | 获取开始迭代器 |
|
||||
| [`end`](end.md) | 获取结束迭代器 |
|
||||
|
||||
## 使用示例
|
||||
|
||||
|
||||
@@ -12,39 +12,16 @@
|
||||
|
||||
## 公共方法
|
||||
|
||||
### 构造/析构
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| `FileWriter()` | 默认构造(不打开文件) |
|
||||
| `FileWriter(const char* filePath, bool append = false)` | 构造并打开文件 |
|
||||
| `~FileWriter()` | 析构函数,自动关闭文件 |
|
||||
|
||||
### 文件操作
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| `bool Open(const char* filePath, bool append = false)` | 打开文件,append=true 时为追加模式 |
|
||||
| `void Close()` | 关闭文件 |
|
||||
| `bool IsOpen() const` | 检查文件是否已打开 |
|
||||
|
||||
### 数据写入
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| `bool Write(const char* data, size_t length)` | 写入指定长度的字符串 |
|
||||
| `bool Write(const Containers::String& str)` | 写入 String 内容 |
|
||||
| `bool Flush()` | 刷新缓冲区,确保数据写入磁盘 |
|
||||
|
||||
## 方法列表
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [Open](Open.md) | 打开文件 |
|
||||
| [Close](Close.md) | 关闭文件 |
|
||||
| [IsOpen](IsOpen.md) | 检查文件是否已打开 |
|
||||
| [Write](Write.md) | 写入数据 |
|
||||
| [Flush](Flush.md) | 刷新缓冲区 |
|
||||
| [`Open`](Open.md) | 打开文件,append=true 时为追加模式 |
|
||||
| [`Close`](Close.md) | 关闭文件 |
|
||||
| [`IsOpen`](IsOpen.md) | 检查文件是否已打开 |
|
||||
| [`Write`](Write.md) | 写入数据 |
|
||||
| [`Flush`](Flush.md) | 刷新缓冲区 |
|
||||
|
||||
## 使用示例
|
||||
|
||||
|
||||
@@ -12,28 +12,13 @@
|
||||
|
||||
## 公共方法
|
||||
|
||||
### 构造/析构
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| `RefCounted()` | 构造函数,初始引用计数为 1 |
|
||||
| `virtual ~RefCounted()` | 虚析构函数 |
|
||||
|
||||
### 引用计数
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| `void AddRef()` | 增加引用计数 |
|
||||
| `void Release()` | 减少引用计数(归零时自动 delete this) |
|
||||
| `uint32_t GetRefCount() const` | 获取当前引用计数 |
|
||||
|
||||
## 方法列表
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [AddRef](AddRef.md) | 增加引用计数 |
|
||||
| [Release](Release.md) | 减少引用计数 |
|
||||
| [GetRefCount](GetRefCount.md) | 获取当前引用计数 |
|
||||
| [`AddRef`](AddRef.md) | 增加引用计数 |
|
||||
| [`Release`](Release.md) | 减少引用计数(归零时自动 delete this) |
|
||||
| [`GetRefCount`](GetRefCount.md) | 获取当前引用计数 |
|
||||
|
||||
## 使用示例
|
||||
|
||||
|
||||
@@ -24,14 +24,14 @@
|
||||
| `Core::MakeRef<T>(Args&&... args)` | `Ref<T>` | 创建共享指针 |
|
||||
| `Core::MakeUnique<T>(Args&&... args)` | `UniqueRef<T>` | 创建独占指针 |
|
||||
|
||||
## 方法列表
|
||||
## 公共方法
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [Ref](Ref.md) | `std::shared_ptr<T>` 类型别名 |
|
||||
| [UniqueRef](UniqueRef.md) | `std::unique_ptr<T>` 类型别名 |
|
||||
| [MakeRef](MakeRef.md) | 创建共享指针的工厂函数 |
|
||||
| [MakeUnique](MakeUnique.md) | 创建独占指针的工厂函数 |
|
||||
| [`Ref`](Ref.md) | `std::shared_ptr<T>` 类型别名 |
|
||||
| [`UniqueRef`](UniqueRef.md) | `std::unique_ptr<T>` 类型别名 |
|
||||
| [`MakeRef`](MakeRef.md) | 创建共享指针的工厂函数 |
|
||||
| [`MakeUnique`](MakeUnique.md) | 创建独占指针的工厂函数 |
|
||||
|
||||
## 使用示例
|
||||
|
||||
|
||||
@@ -26,19 +26,19 @@
|
||||
| `uint64` | `uint64_t` | 64位无符号整数 |
|
||||
| `byte` | `uint8_t` | 字节类型 |
|
||||
|
||||
## 方法列表
|
||||
## 公共方法
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [int8](int8.md) | 8位有符号整数类型别名 |
|
||||
| [int16](int16.md) | 16位有符号整数类型别名 |
|
||||
| [int32](int32.md) | 32位有符号整数类型别名 |
|
||||
| [int64](int64.md) | 64位有符号整数类型别名 |
|
||||
| [uint8](uint8.md) | 8位无符号整数类型别名 |
|
||||
| [uint16](uint16.md) | 16位无符号整数类型别名 |
|
||||
| [uint32](uint32.md) | 32位无符号整数类型别名 |
|
||||
| [uint64](uint64.md) | 64位无符号整数类型别名 |
|
||||
| [byte](byte.md) | 字节类型别名 |
|
||||
| [`int8`](int8.md) | 8位有符号整数类型别名 |
|
||||
| [`int16`](int16.md) | 16位有符号整数类型别名 |
|
||||
| [`int32`](int32.md) | 32位有符号整数类型别名 |
|
||||
| [`int64`](int64.md) | 64位有符号整数类型别名 |
|
||||
| [`uint8`](uint8.md) | 8位无符号整数类型别名 |
|
||||
| [`uint16`](uint16.md) | 16位无符号整数类型别名 |
|
||||
| [`uint32`](uint32.md) | 32位无符号整数类型别名 |
|
||||
| [`uint64`](uint64.md) | 64位无符号整数类型别名 |
|
||||
| [`byte`](byte.md) | 字节类型别名 |
|
||||
|
||||
## 使用示例
|
||||
|
||||
|
||||
Reference in New Issue
Block a user