Make the command documentation slightly more consistent across most all commands

This commit is contained in:
runebaas 2019-05-16 22:10:56 +02:00
parent 03343918b0
commit e4fd828a13
No known key found for this signature in database
GPG key ID: 2677AF508D0300D6
18 changed files with 26 additions and 26 deletions

View file

@ -35,7 +35,7 @@ namespace Geekbot.net.Commands.Admin
[Command("welcome", RunMode = RunMode.Async)] [Command("welcome", RunMode = RunMode.Async)]
[Summary("Set a Welcome Message (use '$user' to mention the new joined user).")] [Summary("Set a Welcome Message (use '$user' to mention the new joined user).")]
public async Task SetWelcomeMessage([Remainder] [Summary("message")] string welcomeMessage) public async Task SetWelcomeMessage([Remainder, Summary("message")] string welcomeMessage)
{ {
var guild = await GetGuildSettings(Context.Guild.Id); var guild = await GetGuildSettings(Context.Guild.Id);
guild.WelcomeMessage = welcomeMessage; guild.WelcomeMessage = welcomeMessage;

View file

@ -30,7 +30,7 @@ namespace Geekbot.net.Commands.Admin
[Command("namehistory", RunMode = RunMode.Async)] [Command("namehistory", RunMode = RunMode.Async)]
[Summary("See past usernames of an user")] [Summary("See past usernames of an user")]
public async Task UsernameHistory([Summary("@user")] IUser user) public async Task UsernameHistory([Summary("@someone")] IUser user)
{ {
try try
{ {

View file

@ -31,7 +31,7 @@ namespace Geekbot.net.Commands.Admin.Owner
[Command("youtubekey", RunMode = RunMode.Async)] [Command("youtubekey", RunMode = RunMode.Async)]
[Summary("Set the youtube api key")] [Summary("Set the youtube api key")]
public async Task SetYoutubeKey([Summary("API Key")] string key) public async Task SetYoutubeKey([Summary("API-Key")] string key)
{ {
await _globalSettings.SetKey("YoutubeKey", key); await _globalSettings.SetKey("YoutubeKey", key);
await ReplyAsync("Apikey has been set"); await ReplyAsync("Apikey has been set");
@ -80,7 +80,7 @@ namespace Geekbot.net.Commands.Admin.Owner
[Command("refreshuser", RunMode = RunMode.Async)] [Command("refreshuser", RunMode = RunMode.Async)]
[Summary("Refresh a user in the user cache")] [Summary("Refresh a user in the user cache")]
public async Task PopUserRepoCommand([Summary("@user")] IUser user) public async Task PopUserRepoCommand([Summary("@someone")] IUser user)
{ {
try try
{ {

View file

@ -60,7 +60,7 @@ namespace Geekbot.net.Commands.Admin
[Command(RunMode = RunMode.Async)] [Command(RunMode = RunMode.Async)]
[Summary("Get a role by mentioning it.")] [Summary("Get a role by mentioning it.")]
public async Task GiveRole([Summary("roleNickname")] string roleNameRaw) public async Task GiveRole([Summary("role-nickname")] string roleNameRaw)
{ {
try try
{ {
@ -144,7 +144,7 @@ namespace Geekbot.net.Commands.Admin
[RequireUserPermission(GuildPermission.ManageRoles)] [RequireUserPermission(GuildPermission.ManageRoles)]
[Command("remove", RunMode = RunMode.Async)] [Command("remove", RunMode = RunMode.Async)]
[Summary("Remove a role from the whitelist.")] [Summary("Remove a role from the whitelist.")]
public async Task RemoveRole([Summary("roleNickname")] string roleName) public async Task RemoveRole([Summary("role-nickname")] string roleName)
{ {
try try
{ {
@ -170,7 +170,7 @@ namespace Geekbot.net.Commands.Admin
[RequireUserPermission(GuildPermission.ManageRoles)] [RequireUserPermission(GuildPermission.ManageRoles)]
[Summary("Give a role by clicking on an emoji")] [Summary("Give a role by clicking on an emoji")]
[Command("listen", RunMode = RunMode.Async)] [Command("listen", RunMode = RunMode.Async)]
public async Task AddListener([Summary("messageID")] string messageId, [Summary("Emoji")] string emoji, [Summary("@role")] IRole role) public async Task AddListener([Summary("message-ID")] string messageId, [Summary("Emoji")] string emoji, [Summary("@role")] IRole role)
{ {
try try
{ {

View file

@ -20,7 +20,7 @@ namespace Geekbot.net.Commands.Games
[Command("pokedex", RunMode = RunMode.Async)] [Command("pokedex", RunMode = RunMode.Async)]
[Summary("A Pokedex Tool")] [Summary("A Pokedex Tool")]
public async Task GetPokemon([Summary("pokemonName")] string pokemonName) public async Task GetPokemon([Summary("pokemon-name")] string pokemonName)
{ {
try try
{ {

View file

@ -32,7 +32,7 @@ namespace Geekbot.net.Commands.Games
[Command("roll", RunMode = RunMode.Async)] [Command("roll", RunMode = RunMode.Async)]
[Summary("Guess which number the bot will roll (1-100")] [Summary("Guess which number the bot will roll (1-100")]
public async Task RollCommand([Remainder] [Summary("guess")] string stuff = "noGuess") public async Task RollCommand([Remainder] [Summary("guess")] string stuff = null)
{ {
try try
{ {

View file

@ -23,7 +23,7 @@ namespace Geekbot.net.Commands.Integrations.Google
[Command("google", RunMode = RunMode.Async)] [Command("google", RunMode = RunMode.Async)]
[Summary("Google Something.")] [Summary("Google Something.")]
public async Task AskGoogle([Remainder, Summary("SearchText")] string searchText) public async Task AskGoogle([Remainder, Summary("search-text")] string searchText)
{ {
try try
{ {

View file

@ -24,7 +24,7 @@ namespace Geekbot.net.Commands.Integrations
[Command("mtg", RunMode = RunMode.Async)] [Command("mtg", RunMode = RunMode.Async)]
[Summary("Find a Magic The Gathering Card.")] [Summary("Find a Magic The Gathering Card.")]
public async Task GetCard([Remainder] [Summary("name")] string cardName) public async Task GetCard([Remainder] [Summary("card-name")] string cardName)
{ {
try try
{ {

View file

@ -23,7 +23,7 @@ namespace Geekbot.net.Commands.Integrations
[Command("anime", RunMode = RunMode.Async)] [Command("anime", RunMode = RunMode.Async)]
[Summary("Show Info about an Anime.")] [Summary("Show Info about an Anime.")]
public async Task SearchAnime([Remainder] [Summary("AnimeName")] string animeName) public async Task SearchAnime([Remainder] [Summary("anime-name")] string animeName)
{ {
try try
{ {
@ -75,7 +75,7 @@ namespace Geekbot.net.Commands.Integrations
[Command("manga", RunMode = RunMode.Async)] [Command("manga", RunMode = RunMode.Async)]
[Summary("Show Info about a Manga.")] [Summary("Show Info about a Manga.")]
public async Task SearchManga([Remainder] [Summary("MangaName")] string mangaName) public async Task SearchManga([Remainder] [Summary("manga-name")] string mangaName)
{ {
try try
{ {

View file

@ -29,7 +29,7 @@ namespace Geekbot.net.Commands.Integrations
[Command("wiki", RunMode = RunMode.Async)] [Command("wiki", RunMode = RunMode.Async)]
[Summary("Get an article from wikipedia.")] [Summary("Get an article from wikipedia.")]
public async Task GetPreview([Remainder] [Summary("Article")] string articleName) public async Task GetPreview([Remainder] [Summary("article")] string articleName)
{ {
try try
{ {

View file

@ -21,7 +21,7 @@ namespace Geekbot.net.Commands.Integrations
[Command("yt", RunMode = RunMode.Async)] [Command("yt", RunMode = RunMode.Async)]
[Summary("Search for something on youtube.")] [Summary("Search for something on youtube.")]
public async Task Yt([Remainder] [Summary("Title")] string searchQuery) public async Task Yt([Remainder] [Summary("title")] string searchQuery)
{ {
var key = _globalSettings.GetKey("YoutubeKey"); var key = _globalSettings.GetKey("YoutubeKey");
if (string.IsNullOrEmpty(key)) if (string.IsNullOrEmpty(key))

View file

@ -17,7 +17,7 @@ namespace Geekbot.net.Commands.Randomness
[Command("8ball", RunMode = RunMode.Async)] [Command("8ball", RunMode = RunMode.Async)]
[Summary("Ask 8Ball a Question.")] [Summary("Ask 8Ball a Question.")]
public async Task Ball([Remainder] [Summary("Question")] string echo) public async Task Ball([Remainder] [Summary("question")] string echo)
{ {
try try
{ {

View file

@ -26,7 +26,7 @@ namespace Geekbot.net.Commands.Randomness
[Command("Ship", RunMode = RunMode.Async)] [Command("Ship", RunMode = RunMode.Async)]
[Summary("Ask the Shipping meter")] [Summary("Ask the Shipping meter")]
public async Task Command([Summary("@User1")] IUser user1, [Summary("@User2")] IUser user2) public async Task Command([Summary("@user1")] IUser user1, [Summary("@user2")] IUser user2)
{ {
try try
{ {

View file

@ -24,7 +24,7 @@ namespace Geekbot.net.Commands.Randomness
[Command("slap", RunMode = RunMode.Async)] [Command("slap", RunMode = RunMode.Async)]
[Summary("slap someone")] [Summary("slap someone")]
public async Task Slapper([Summary("@user")] IUser user) public async Task Slapper([Summary("@someone")] IUser user)
{ {
try try
{ {

View file

@ -74,7 +74,7 @@ namespace Geekbot.net.Commands.Rpg
[Command("give", RunMode = RunMode.Async)] [Command("give", RunMode = RunMode.Async)]
[Summary("Give cookies to someone")] [Summary("Give cookies to someone")]
public async Task GiveACookie([Summary("User")] IUser user, [Summary("amount")] int amount = 1) public async Task GiveACookie([Summary("@someone")] IUser user, [Summary("amount")] int amount = 1)
{ {
try try
{ {

View file

@ -17,7 +17,7 @@ namespace Geekbot.net.Commands.Utils
[Command("avatar", RunMode = RunMode.Async)] [Command("avatar", RunMode = RunMode.Async)]
[Summary("Get someones avatar")] [Summary("Get someones avatar")]
public async Task GetAvatar([Remainder] [Summary("user")] IUser user = null) public async Task GetAvatar([Remainder, Summary("@someone")] IUser user = null)
{ {
try try
{ {

View file

@ -19,7 +19,7 @@ namespace Geekbot.net.Commands.Utils.Dice
[Command("dice", RunMode = RunMode.Async)] [Command("dice", RunMode = RunMode.Async)]
[Summary("Roll a dice.")] [Summary("Roll a dice.")]
public async Task RollCommand([Remainder] [Summary("diceType")] string diceType = "1d20") public async Task RollCommand([Remainder] [Summary("dice-type")] string diceType = "1d20")
{ {
var splitedDices = diceType.Split("+"); var splitedDices = diceType.Split("+");
var dices = new List<DiceTypeDto>(); var dices = new List<DiceTypeDto>();

View file

@ -60,7 +60,7 @@ namespace Geekbot.net.Commands.Utils.Quote
[Command("save")] [Command("save")]
[Summary("Save a quote from the last sent message by @user")] [Summary("Save a quote from the last sent message by @user")]
public async Task SaveQuote([Summary("@user")] IUser user) public async Task SaveQuote([Summary("@someone")] IUser user)
{ {
try try
{ {
@ -96,7 +96,7 @@ namespace Geekbot.net.Commands.Utils.Quote
[Command("save")] [Command("save")]
[Summary("Save a quote from a message id")] [Summary("Save a quote from a message id")]
public async Task SaveQuote([Summary("messageId")] ulong messageId) public async Task SaveQuote([Summary("message-ID")] ulong messageId)
{ {
try try
{ {
@ -130,7 +130,7 @@ namespace Geekbot.net.Commands.Utils.Quote
[Command("make")] [Command("make")]
[Summary("Create a quote from the last sent message by @user")] [Summary("Create a quote from the last sent message by @user")]
public async Task ReturnSpecifiedQuote([Summary("@user")] IUser user) public async Task ReturnSpecifiedQuote([Summary("@someone")] IUser user)
{ {
try try
{ {
@ -149,7 +149,7 @@ namespace Geekbot.net.Commands.Utils.Quote
[Command("make")] [Command("make")]
[Summary("Create a quote from a message id")] [Summary("Create a quote from a message id")]
public async Task ReturnSpecifiedQuote([Summary("messageId")] ulong messageId) public async Task ReturnSpecifiedQuote([Summary("message-ID")] ulong messageId)
{ {
try try
{ {
@ -170,7 +170,7 @@ namespace Geekbot.net.Commands.Utils.Quote
[RequireUserPermission(GuildPermission.ManageMessages)] [RequireUserPermission(GuildPermission.ManageMessages)]
[RequireUserPermission(GuildPermission.ManageRoles)] [RequireUserPermission(GuildPermission.ManageRoles)]
[Summary("Remove a quote (required mod permissions)")] [Summary("Remove a quote (required mod permissions)")]
public async Task RemoveQuote([Summary("quoteId")] int id) public async Task RemoveQuote([Summary("quote-ID")] int id)
{ {
try try
{ {