Added xml summary and renamed non-standard member/type names

Mirai-NET-Shelter · Mar 2, 2022 · b1243e0 · b1243e0
1 parent af48095
commit b1243e0
Show file tree

Hide file tree

Showing 6 changed files with 114 additions and 4 deletions.
diff --git a/Mirai.Net/Data/Messages/MessageChain.cs b/Mirai.Net/Data/Messages/MessageChain.cs
@@ -2,9 +2,6 @@
 
 namespace Mirai.Net.Data.Messages;
 
-/// <summary>
-/// 
-/// </summary>
 //just a definition in Data namespace
 public partial class MessageChain : List<MessageBase>
 {

diff --git a/Mirai.Net/Utils/Scaffolds/MessageChain.cs b/Mirai.Net/Utils/Scaffolds/MessageChain.cs
@@ -10,12 +10,22 @@
 // ReSharper disable once CheckNamespace
 namespace Mirai.Net.Data.Messages;
 
+/// <summary>
+/// 消息链
+/// </summary>
 public partial class MessageChain : List<MessageBase>
 {
+    /// <summary>
+    /// AddRange
+    /// </summary>
+    /// <param name="collection"></param>
     public MessageChain(IEnumerable<MessageBase> collection) : base(collection)
     {
     }
 
+    /// <summary>
+    /// 
+    /// </summary>
     public MessageChain() : base()
     {
     }

diff --git a/Mirai.Net/Utils/Scaffolds/MessageChainBuilder.cs b/Mirai.Net/Utils/Scaffolds/MessageChainBuilder.cs
@@ -4,6 +4,9 @@
 
 namespace Mirai.Net.Utils.Scaffolds;
 
+/// <summary>
+/// 消息链建造者
+/// </summary>
 public class MessageChainBuilder
 {
     private readonly MessageChain _chain = new();
@@ -311,6 +314,10 @@ public MessageChainBuilder VoiceFromUrl(string url)
         return this;
     }
 
+    /// <summary>
+    /// 建造消息链
+    /// </summary>
+    /// <returns></returns>
     public MessageChain Build()
     {
         return _chain;

diff --git a/Mirai.Net/Utils/Scaffolds/MessageScaffold.cs b/Mirai.Net/Utils/Scaffolds/MessageScaffold.cs
@@ -14,6 +14,12 @@ public static class MessageScaffold
 {
     #region Legacy
 
+    /// <summary>
+    /// 
+    /// </summary>
+    /// <param name="origin"></param>
+    /// <param name="append"></param>
+    /// <returns></returns>
     public static MessageChain Append(this string origin, params MessageBase[] append)
     {
         var re = new MessageChain { new PlainMessage(origin) };
@@ -22,6 +28,12 @@ public static MessageChain Append(this string origin, params MessageBase[] appen
         return re;
     }
 
+    /// <summary>
+    /// 
+    /// </summary>
+    /// <param name="origin"></param>
+    /// <param name="append"></param>
+    /// <returns></returns>
     public static MessageChain Append(this string origin, IEnumerable<MessageBase> append)
     {
         var re = new MessageChain { new PlainMessage(origin) };
@@ -30,13 +42,25 @@ public static MessageChain Append(this string origin, IEnumerable<MessageBase> a
         return re;
     }
 
+    /// <summary>
+    /// 
+    /// </summary>
+    /// <param name="origin"></param>
+    /// <param name="append"></param>
+    /// <returns></returns>
     public static MessageChain Append(this string origin, string append)
     {
         var re = new MessageChain { new PlainMessage(origin), new PlainMessage(append) };
 
         return re;
     }
 
+    /// <summary>
+    /// 
+    /// </summary>
+    /// <param name="messageBase"></param>
+    /// <param name="append"></param>
+    /// <returns></returns>
     public static MessageChain Append(this MessageBase messageBase, params MessageBase[] append)
     {
         var re = new MessageChain { messageBase };
@@ -45,6 +69,12 @@ public static MessageChain Append(this MessageBase messageBase, params MessageBa
         return re;
     }
 
+    /// <summary>
+    /// 
+    /// </summary>
+    /// <param name="messageBase"></param>
+    /// <param name="append"></param>
+    /// <returns></returns>
     public static MessageChain Append(this MessageBase messageBase, IEnumerable<MessageBase> append)
     {
         var re = new MessageChain { messageBase };
@@ -53,13 +83,25 @@ public static MessageChain Append(this MessageBase messageBase, IEnumerable<Mess
         return re;
     }
 
+    /// <summary>
+    /// 
+    /// </summary>
+    /// <param name="messageBase"></param>
+    /// <param name="append"></param>
+    /// <returns></returns>
     public static MessageChain Append(this MessageBase messageBase, string append)
     {
         var re = new MessageChain { messageBase, new PlainMessage(append) };
 
         return re;
     }
 
+    /// <summary>
+    /// 
+    /// </summary>
+    /// <param name="bases"></param>
+    /// <param name="append"></param>
+    /// <returns></returns>
     public static MessageChain Append(this IEnumerable<MessageBase> bases, params MessageBase[] append)
     {
         var re = bases.ToList();
@@ -68,6 +110,12 @@ public static MessageChain Append(this IEnumerable<MessageBase> bases, params Me
         return re.ToMessageChain();
     }
 
+    /// <summary>
+    /// 
+    /// </summary>
+    /// <param name="bases"></param>
+    /// <param name="append"></param>
+    /// <returns></returns>
     public static MessageChain Append(this IEnumerable<MessageBase> bases, string append)
     {
         var re = bases.ToList();
@@ -76,6 +124,12 @@ public static MessageChain Append(this IEnumerable<MessageBase> bases, string ap
         return re.ToMessageChain();
     }
 
+    /// <summary>
+    /// 
+    /// </summary>
+    /// <param name="bases"></param>
+    /// <param name="append"></param>
+    /// <returns></returns>
     public static MessageChain Append(this IEnumerable<MessageBase> bases, IEnumerable<MessageBase> append)
     {
         var re = bases.ToList();

diff --git a/Mirai.Net/Utils/Scaffolds/MiraiScaffold.cs b/Mirai.Net/Utils/Scaffolds/MiraiScaffold.cs
@@ -15,6 +15,9 @@
 
 namespace Mirai.Net.Utils.Scaffolds;
 
+/// <summary>
+/// mirai相关拓展方法
+/// </summary>
 public static class MiraiScaffold
 {
     #region MiraiBot extensions
@@ -176,6 +179,12 @@ await MessageManager
             .RecallAsync(id);
     }
 
+    /// <summary>
+    /// 回复消息
+    /// </summary>
+    /// <param name="receiver"></param>
+    /// <param name="chain"></param>
+    /// <returns></returns>
     public static async Task<string> QuoteMessageAsync(this FriendMessageReceiver receiver,
         MessageChain chain)
     {
@@ -185,6 +194,12 @@ public static async Task<string> QuoteMessageAsync(this FriendMessageReceiver re
             .QuoteFriendMessageAsync(receiver.Sender.Id, id, chain);
     }
 
+    /// <summary>
+    /// 回复消息
+    /// </summary>
+    /// <param name="receiver"></param>
+    /// <param name="chain"></param>
+    /// <returns></returns>
     public static async Task<string> QuoteMessageAsync(this GroupMessageReceiver receiver,
         MessageChain chain)
     {
@@ -194,6 +209,12 @@ public static async Task<string> QuoteMessageAsync(this GroupMessageReceiver rec
             .QuoteGroupMessageAsync(receiver.Sender.Group.Id, id, chain);
     }
 
+    /// <summary>
+    /// 回复消息
+    /// </summary>
+    /// <param name="receiver"></param>
+    /// <param name="chain"></param>
+    /// <returns></returns>
     public static async Task<string> QuoteMessageAsync(this TempMessageReceiver receiver,
         MessageChain chain)
     {
@@ -203,6 +224,12 @@ public static async Task<string> QuoteMessageAsync(this TempMessageReceiver rece
             .QuoteTempMessageAsync(receiver.Sender.Id, receiver.Sender.Group.Id, id, chain);
     }
 
+    /// <summary>
+    /// 回复消息
+    /// </summary>
+    /// <param name="receiver"></param>
+    /// <param name="message"></param>
+    /// <returns></returns>
     public static async Task<string> QuoteMessageAsync(this FriendMessageReceiver receiver, string message)
     {
         var id = receiver.MessageChain.OfType<SourceMessage>().First().MessageId;
@@ -211,6 +238,12 @@ public static async Task<string> QuoteMessageAsync(this FriendMessageReceiver re
             .QuoteFriendMessageAsync(receiver.Sender.Id, id, message);
     }
 
+    /// <summary>
+    /// 回复消息
+    /// </summary>
+    /// <param name="receiver"></param>
+    /// <param name="message"></param>
+    /// <returns></returns>
     public static async Task<string> QuoteMessageAsync(this GroupMessageReceiver receiver, string message)
     {
         var id = receiver.MessageChain.ToList().OfType<SourceMessage>().First().MessageId;
@@ -219,6 +252,12 @@ public static async Task<string> QuoteMessageAsync(this GroupMessageReceiver rec
             .QuoteGroupMessageAsync(receiver.Sender.Group.Id, id, message);
     }
 
+    /// <summary>
+    /// 回复消息
+    /// </summary>
+    /// <param name="receiver"></param>
+    /// <param name="message"></param>
+    /// <returns></returns>
     public static async Task<string> QuoteMessageAsync(this TempMessageReceiver receiver, string message)
     {
         var id = receiver.MessageChain.OfType<SourceMessage>().First().MessageId;

diff --git a/Mirai.Net/Utils/Scaffolds/ModuleScaffold.cs b/Mirai.Net/Utils/Scaffolds/ModuleScaffold.cs
@@ -7,6 +7,9 @@
 
 namespace Mirai.Net.Utils.Scaffolds;
 
+/// <summary>
+/// 模块化拓展方法
+/// </summary>
 public static class ModuleScaffold
 {
     /// <summary>
@@ -32,7 +35,7 @@ public static IEnumerable<IModule> GetModules<T>(this T module) where T : IModul
     /// </summary>
     /// <param name="modules"></param>
     /// <param name="base"></param>
-    public static void SubscribeModule(this IEnumerable<IModule> modules, MessageReceiverBase @base)
+    public static void Raise(this IEnumerable<IModule> modules, MessageReceiverBase @base)
     {
         foreach (var module in modules)
         {