Skip to content

Commit 04571b0

Browse files
CopilotJusterZhu
Copilot
and
JusterZhu
committed
Fix HTML tag escaping in GeneralUpdate.Extension documentation
Co-authored-by: JusterZhu <11714536+JusterZhu@users.noreply.github.com>
1 parent 1f1084e commit 04571b0

4 files changed

Lines changed: 40 additions & 21 deletions

File tree

‎website/docs/doc/GeneralUpdate.Extension.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ GeneralUpdate.Extension 提供以下扩展功能。
6464

6565
| 方法 | 说明 |
6666
| --------------------- | ------------------------------------------------------------ |
67-
| AddCustomOption() | 向更新工作流注入自定义异步操作。在更新开始前执行。非常适合环境检查、更新前备份或任何准备任务。返回 Task<bool>，返回 false 将取消更新。 |
67+
| AddCustomOption() | 向更新工作流注入自定义异步操作。在更新开始前执行。非常适合环境检查、更新前备份或任何准备任务。返回 Task&lt;bool&gt;，返回 false 将取消更新。 |
6868
| SetCustomSkipOption() | 允许用户决定是否跳过非强制更新。提供一种显示自定义 UI 以获取用户同意的方法。仅在服务器未强制更新时有效。 |
6969
| SetBlacklist() | 定义永远不应更新的文件或文件格式。对于保留用户数据、配置文件或第三方依赖项很有用。 |
7070

@@ -110,7 +110,7 @@ GeneralUpdate.Extension 提供以下扩展功能。
110110
| 属性 | 类型 | 说明 |
111111
| ---------------------- | --------------- | ------------------------------------------ |
112112
| IsAllDownloadCompleted | bool | 是否所有下载都成功完成|
113-
| FailedVersions | List<VersionInfo>| 下载失败的版本列表 |
113+
| FailedVersions | List&lt;VersionInfo&gt;| 下载失败的版本列表 |
114114

115115
#### MultiDownloadErrorEventArgs
116116

@@ -210,19 +210,19 @@ await new GeneralClientBootstrap()
210210
var configinfo = new Configinfo
211211
{
212212
// ... 其他配置
213-
BlackFiles = new List<string>
213+
BlackFiles = new List&lt;string&gt;
214214
{
215215
"userconfig.json",
216216
"license.dat",
217217
"custom.db"
218218
},
219-
BlackFormats = new List<string>
219+
BlackFormats = new List&lt;string&gt;
220220
{
221221
".log",
222222
".temp",
223223
".cache"
224224
},
225-
BlackDirectories = new List<string>
225+
BlackDirectories = new List&lt;string&gt;
226226
{
227227
"UserData",
228228
"Plugins\\Custom"
@@ -231,7 +231,7 @@ var configinfo = new Configinfo
231231

232232
// 或使用 SetBlacklist 方法
233233
await new GeneralClientBootstrap()
234-
.SetBlacklist(blackFiles: new List<string> { "config.ini" })
234+
.SetBlacklist(blackFiles: new List&lt;string&gt; { "config.ini" })
235235
.SetConfig(configinfo)
236236
.LaunchAsync();
237237
```
@@ -260,7 +260,7 @@ public class UpdateManager
260260
ProductId = "your-product-id",
261261
AppSecretKey = "your-secret-key",
262262
InstallPath = AppDomain.CurrentDomain.BaseDirectory,
263-
BlackFiles = new List<string> { "userdata.db" }
263+
BlackFiles = new List&lt;string&gt; { "userdata.db" }
264264
};
265265

266266
try

‎website/i18n/en/docusaurus-plugin-content-docs/current/docs/doc/GeneralUpdate.Extension.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ GeneralUpdate.Extension provides the following extensibility features.
6464

6565
| Method | Description |
6666
| --------------------- | ------------------------------------------------------------ |
67-
| AddCustomOption() | Inject custom asynchronous operations into the update workflow. Executed before the update starts. Perfect for environment checks, pre-update backups, or any preparatory tasks. Returns a Task<bool> where false cancels the update. |
67+
| AddCustomOption() | Inject custom asynchronous operations into the update workflow. Executed before the update starts. Perfect for environment checks, pre-update backups, or any preparatory tasks. Returns a Task&lt;bool&gt; where false cancels the update. |
6868
| SetCustomSkipOption() | Allows users to decide whether to skip non-mandatory updates. Provides a way to show custom UI for user consent. Only effective when the server doesn't enforce mandatory updates. |
6969
| SetBlacklist() | Define files or file formats that should never be updated. Useful for preserving user data, configuration files, or third-party dependencies. |
7070

@@ -110,7 +110,7 @@ Summary of all download tasks.
110110
| Property | Type | Description |
111111
| ---------------------- | --------------- | ------------------------------------------ |
112112
| IsAllDownloadCompleted | bool | Whether all downloads completed successfully|
113-
| FailedVersions | List<VersionInfo>| List of versions that failed to download |
113+
| FailedVersions | List&lt;VersionInfo&gt;| List of versions that failed to download |
114114

115115
#### MultiDownloadErrorEventArgs
116116

@@ -210,19 +210,19 @@ Exclude specific files or formats from updates:
210210
var configinfo = new Configinfo
211211
{
212212
// ... other configuration
213-
BlackFiles = new List<string>
213+
BlackFiles = new List&lt;string&gt;
214214
{
215215
"userconfig.json",
216216
"license.dat",
217217
"custom.db"
218218
},
219-
BlackFormats = new List<string>
219+
BlackFormats = new List&lt;string&gt;
220220
{
221221
".log",
222222
".temp",
223223
".cache"
224224
},
225-
BlackDirectories = new List<string>
225+
BlackDirectories = new List&lt;string&gt;
226226
{
227227
"UserData",
228228
"Plugins\\Custom"
@@ -231,7 +231,7 @@ var configinfo = new Configinfo
231231

232232
// Or use the SetBlacklist method
233233
await new GeneralClientBootstrap()
234-
.SetBlacklist(blackFiles: new List<string> { "config.ini" })
234+
.SetBlacklist(blackFiles: new List&lt;string&gt; { "config.ini" })
235235
.SetConfig(configinfo)
236236
.LaunchAsync();
237237
```
@@ -260,7 +260,7 @@ public class UpdateManager
260260
ProductId = "your-product-id",
261261
AppSecretKey = "your-secret-key",
262262
InstallPath = AppDomain.CurrentDomain.BaseDirectory,
263-
BlackFiles = new List<string> { "userdata.db" }
263+
BlackFiles = new List&lt;string&gt; { "userdata.db" }
264264
};
265265

266266
try

‎website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/doc/GeneralUpdate.Extension.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ GeneralUpdate.Extension 提供以下扩展功能。
6464

6565
| 方法 | 说明 |
6666
| --------------------- | ------------------------------------------------------------ |
67-
| AddCustomOption() | 向更新工作流注入自定义异步操作。在更新开始前执行。非常适合环境检查、更新前备份或任何准备任务。返回 Task<bool>，返回 false 将取消更新。 |
67+
| AddCustomOption() | 向更新工作流注入自定义异步操作。在更新开始前执行。非常适合环境检查、更新前备份或任何准备任务。返回 Task&lt;bool&gt;，返回 false 将取消更新。 |
6868
| SetCustomSkipOption() | 允许用户决定是否跳过非强制更新。提供一种显示自定义 UI 以获取用户同意的方法。仅在服务器未强制更新时有效。 |
6969
| SetBlacklist() | 定义永远不应更新的文件或文件格式。对于保留用户数据、配置文件或第三方依赖项很有用。 |
7070

@@ -110,7 +110,7 @@ GeneralUpdate.Extension 提供以下扩展功能。
110110
| 属性 | 类型 | 说明 |
111111
| ---------------------- | --------------- | ------------------------------------------ |
112112
| IsAllDownloadCompleted | bool | 是否所有下载都成功完成|
113-
| FailedVersions | List<VersionInfo>| 下载失败的版本列表 |
113+
| FailedVersions | List&lt;VersionInfo&gt;| 下载失败的版本列表 |
114114

115115
#### MultiDownloadErrorEventArgs
116116

@@ -210,19 +210,19 @@ await new GeneralClientBootstrap()
210210
var configinfo = new Configinfo
211211
{
212212
// ... 其他配置
213-
BlackFiles = new List<string>
213+
BlackFiles = new List&lt;string&gt;
214214
{
215215
"userconfig.json",
216216
"license.dat",
217217
"custom.db"
218218
},
219-
BlackFormats = new List<string>
219+
BlackFormats = new List&lt;string&gt;
220220
{
221221
".log",
222222
".temp",
223223
".cache"
224224
},
225-
BlackDirectories = new List<string>
225+
BlackDirectories = new List&lt;string&gt;
226226
{
227227
"UserData",
228228
"Plugins\\Custom"
@@ -231,7 +231,7 @@ var configinfo = new Configinfo
231231

232232
// 或使用 SetBlacklist 方法
233233
await new GeneralClientBootstrap()
234-
.SetBlacklist(blackFiles: new List<string> { "config.ini" })
234+
.SetBlacklist(blackFiles: new List&lt;string&gt; { "config.ini" })
235235
.SetConfig(configinfo)
236236
.LaunchAsync();
237237
```
@@ -260,7 +260,7 @@ public class UpdateManager
260260
ProductId = "your-product-id",
261261
AppSecretKey = "your-secret-key",
262262
InstallPath = AppDomain.CurrentDomain.BaseDirectory,
263-
BlackFiles = new List<string> { "userdata.db" }
263+
BlackFiles = new List&lt;string&gt; { "userdata.db" }
264264
};
265265

266266
try

‎website/package-lock.json‎

Lines changed: 19 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)