Add descriptions to current modules for Issue #18

bealsbe · May 2, 2020 · 166f968 · 166f968
1 parent c98d34b
commit 166f968
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 0 deletions.
diff --git a/Floofbot/Modules/Administration.cs b/Floofbot/Modules/Administration.cs
@@ -16,6 +16,7 @@ public class Administration : ModuleBase<SocketCommandContext>
 
         [Command("ban")]
         [Alias("b")]
+        [Summary("Bans a user from the server")]
         [RequireContext(ContextType.Guild)]
         [RequireUserPermission(GuildPermission.BanMembers)]
         public async Task YeetUser(string input, [Remainder] string reason = "No Reason Provided")
@@ -48,6 +49,7 @@ public async Task YeetUser(string input, [Remainder] string reason = "No Reason
         }
         [Command("kick")]
         [Alias("k")]
+        [Summary("Kicks a user from the server")]
         [RequireContext(ContextType.Guild)]
         [RequireUserPermission(GuildPermission.KickMembers)]
         public async Task kickUser(string user, [Remainder] string reason = "No Reason Provided")
@@ -79,6 +81,7 @@ public async Task kickUser(string user, [Remainder] string reason = "No Reason P
 
         [Command("warn")]
         [Alias("w")]
+        [Summary("Warns a user on the server, with a given reason")]
         [RequireContext(ContextType.Guild)]
         [RequireUserPermission(GuildPermission.BanMembers)]
         public async Task warnUser(string user, [Remainder] string reason = "")
@@ -128,6 +131,7 @@ public async Task warnUser(string user, [Remainder] string reason = "")
 
         [Command("warnlog")]
         [Alias("wl")]
+        [Summary("Displays the warning log for a given user")]
         [RequireContext(ContextType.Guild)]
         [RequireUserPermission(GuildPermission.BanMembers)]
         public async Task warnlog(string user)
@@ -154,6 +158,7 @@ public async Task warnlog(string user)
 
 
         [Command("lock")]
+        [Summary("Locks a channel")]
         [RequireContext(ContextType.Guild)]
         [RequireUserPermission(GuildPermission.ManageMessages)]
         public async Task ChannelLock()
@@ -178,6 +183,7 @@ public async Task ChannelLock()
         }
 
         [Command("unlock")]
+        [Summary("Unlocks a channel")]
         [RequireContext(ContextType.Guild)]
         [RequireUserPermission(GuildPermission.ManageMessages)]
 
@@ -204,6 +210,7 @@ public async Task ChannelUnLock()
 
         // rfurry Discord Rules Gate
         [Command("ireadtherules")]
+        [Summary("Allows a user into the server")]
         public async Task getaccess()
         {
             if (Context.Guild.Id == 225980129799700481) {

diff --git a/Floofbot/Modules/Fun.cs b/Floofbot/Modules/Fun.cs
@@ -11,6 +11,7 @@ public class fun : ModuleBase<SocketCommandContext>
     {
 
         [Command("8ball")]
+        [Summary("Gives an 8ball response to a given question")]
         public async Task eightball([Remainder]string question)
         {
             var responses = new List<string> {

diff --git a/Floofbot/Modules/Tag.cs b/Floofbot/Modules/Tag.cs
@@ -30,6 +30,7 @@ public Tag()
             }
 
             [Command("add")]
+            [Summary("Adds a tag")]
             [Priority(0)]
             [RequireUserPermission(GuildPermission.AttachFiles)]
             public async Task Add(string Tag, [Remainder] string Content = null)
@@ -87,6 +88,7 @@ public async Task Add()
 
             //TODO: Fix me
             [Command("list")]
+            [Summary("Lists all tags")]
             [RequireUserPermission(GuildPermission.AttachFiles)]
             public async Task Listtags([Remainder] string Content = null)
             {
@@ -119,6 +121,7 @@ public async Task Listtags([Remainder] string Content = null)
             }
 
             [Command("remove")]
+            [Summary("Removes a tag")]
             [RequireUserPermission(GuildPermission.ManageMessages)]
             public async Task Remove(string tag)
             {
@@ -162,6 +165,7 @@ public async Task Remove()
             }
 
             [Command]
+            [Summary("Displays a tag")]
             [RequireUserPermission(GuildPermission.AttachFiles)]
             public async Task GetTag(string Tag)
             {

diff --git a/Floofbot/Modules/Utilities.cs b/Floofbot/Modules/Utilities.cs
@@ -8,6 +8,7 @@ namespace Floofbot
     public class Utilities : ModuleBase<SocketCommandContext>
     {
         [Command("ping")]
+        [Summary("Responds with the ping in milliseconds")]
         public async Task Ping()
         {
             var sw = Stopwatch.StartNew();
@@ -25,6 +26,7 @@ public async Task Ping()
         }
 
         [Command("userinfo")]
+        [Summary("Displays information on a mentioned user. If no parameters are given, displays user's own information")]
         [RequireContext(ContextType.Guild)]
         public async Task UserInfo(IGuildUser usr = null)
         {
@@ -57,6 +59,7 @@ public async Task UserInfo(IGuildUser usr = null)
         }
 
         [Command("avatar")]
+        [Summary("Displays a mentioned user's avatar. If no parameters are given, displays user's own avatar")]
         [RequireContext(ContextType.Guild)]
         public async Task Avatar([Remainder] IGuildUser user = null)
         {