From 6e95946eca3dd099ee30d9784d151f92a80a9f6d Mon Sep 17 00:00:00 2001
From: real-zony <zony@myzony.com>
Date: Thu, 21 Oct 2021 16:01:06 +0800
Subject: [PATCH] =?UTF-8?q?docs:=20=E5=AE=8C=E5=96=84=E4=BB=A3=E7=A0=81?=
 =?UTF-8?q?=E7=9A=84=20XML=20=E6=B3=A8=E9=87=8A=E3=80=82?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .../Infrastructure/Tag/BlockWordDictionary.cs         |  1 +
 .../Infrastructure/Tag/BlockWordOption.cs             |  3 +++
 .../Infrastructure/Tag/IBlockWordDictionary.cs        | 11 +++++++++++
 3 files changed, 15 insertions(+)

diff --git a/src/ZonyLrcTools.Cli/Infrastructure/Tag/BlockWordDictionary.cs b/src/ZonyLrcTools.Cli/Infrastructure/Tag/BlockWordDictionary.cs
index 53736b5..5d93000 100644
--- a/src/ZonyLrcTools.Cli/Infrastructure/Tag/BlockWordDictionary.cs
+++ b/src/ZonyLrcTools.Cli/Infrastructure/Tag/BlockWordDictionary.cs
@@ -8,6 +8,7 @@ using ZonyLrcTools.Cli.Infrastructure.DependencyInject;
 
 namespace ZonyLrcTools.Cli.Infrastructure.Tag
 {
+    /// <inheritdoc cref="ZonyLrcTools.Cli.Infrastructure.Tag.IBlockWordDictionary" />
     public class BlockWordDictionary : IBlockWordDictionary, ISingletonDependency
     {
         private readonly ToolOptions _options;
diff --git a/src/ZonyLrcTools.Cli/Infrastructure/Tag/BlockWordOption.cs b/src/ZonyLrcTools.Cli/Infrastructure/Tag/BlockWordOption.cs
index 51f40af..6805b76 100644
--- a/src/ZonyLrcTools.Cli/Infrastructure/Tag/BlockWordOption.cs
+++ b/src/ZonyLrcTools.Cli/Infrastructure/Tag/BlockWordOption.cs
@@ -1,5 +1,8 @@
 namespace ZonyLrcTools.Cli.Infrastructure.Tag
 {
+    /// <summary>
+    /// 屏蔽词选项类。
+    /// </summary>
     public class BlockWordOption
     {
         /// <summary>
diff --git a/src/ZonyLrcTools.Cli/Infrastructure/Tag/IBlockWordDictionary.cs b/src/ZonyLrcTools.Cli/Infrastructure/Tag/IBlockWordDictionary.cs
index 6e7960a..3f351ab 100644
--- a/src/ZonyLrcTools.Cli/Infrastructure/Tag/IBlockWordDictionary.cs
+++ b/src/ZonyLrcTools.Cli/Infrastructure/Tag/IBlockWordDictionary.cs
@@ -1,7 +1,18 @@
 namespace ZonyLrcTools.Cli.Infrastructure.Tag
 {
+    /// <summary>
+    /// 屏蔽词字典。
+    /// </summary>
     public interface IBlockWordDictionary
     {
+        /// <summary>
+        /// 根据 <paramref name="key"/> 获得屏蔽词结果。
+        /// </summary>
+        /// <remarks>
+        /// 例: 原歌曲的 "fuckking" ，在网易云实际为 "***kking"。
+        /// </remarks>
+        /// <param name="key">原始单词。</param>
+        /// <returns>原始单词对应的屏蔽词。</returns>
         string GetValue(string key);
     }
 }
\ No newline at end of file