Skip to content

Commit

Permalink
Update code documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
monambike committed Feb 11, 2024
1 parent 2727e36 commit 4bbab2d
Show file tree
Hide file tree
Showing 4 changed files with 164 additions and 9 deletions.
7 changes: 0 additions & 7 deletions src/Commands/Prefix/PrefixPokemon.cs

This file was deleted.

22 changes: 21 additions & 1 deletion src/Commands/Prefix/PrefixThemeTramontina.cs
Original file line number Diff line number Diff line change
Expand Up @@ -41,23 +41,43 @@ internal class PrefixThemeTramontina : BaseCommandModule
/// Represents the command to set the Halloween Theme.
/// </summary>
internal PrefixCommand themeHalloween = new(nameof(themeHalloween), @"Define o servidor para o tema de halloween.", Manage, Permissions.Administrator);


/// <summary>
/// Represents the asynchronous prefix reset theme method called when user asks for the prefix reset theme command.
/// </summary>
/// <param name="commandContext">The command context from the current command call.</param>
/// <returns>A <see cref="Task"/> from the current asynchronous task.</returns>
[Command(nameof(themeReset))]
[RequireUserPermissions(Permissions.Administrator)]
internal async Task ResetThemeAsync(CommandContext commandContext)
=> await ThemeTramontina.ResetThemeAsync(commandContext.Channel, commandContext.Client);


/// <summary>
/// Represents the asynchronous prefix christmas theme method called when user asks for the prefix christmas theme command.
/// </summary>
/// <param name="commandContext">The command context from the current command call.</param>
/// <returns>A <see cref="Task"/> from the current asynchronous task.</returns>
[Command(nameof(themeChristmas))]
[RequireUserPermissions(Permissions.Administrator)]
internal async Task SetChristmasThemeAsync(CommandContext commandContext)
=> await ThemeTramontina.SetChristmasThemeAsync(commandContext.Channel, commandContext.Client);

/// <summary>
/// Represents the asynchronous prefix easter theme method called when user asks for the prefix easter theme command.
/// </summary>
/// <param name="commandContext">The command context from the current command call.</param>
/// <returns>A <see cref="Task"/> from the current asynchronous task.</returns>
[Command(nameof(themeEaster))]
[RequireUserPermissions(Permissions.Administrator)]
internal async Task SetEasterThemeAsync(CommandContext commandContext)
=> await ThemeTramontina.SetEasterThemeAsync(commandContext.Channel, commandContext.Client);

/// <summary>
/// Represents the asynchronous prefix halloween theme method called when user asks for the prefix halloween theme command.
/// </summary>
/// <param name="commandContext">The command context from the current command call.</param>
/// <returns>A <see cref="Task"/> from the current asynchronous task.</returns>
[Command(nameof(themeHalloween))]
[RequireUserPermissions(Permissions.Administrator)]
internal async Task SetHalloweenThemeAsync(CommandContext commandContext)
Expand Down
21 changes: 20 additions & 1 deletion src/Commands/Slash/SlashThemeTramontina.cs
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,11 @@ namespace KWiJisho.Commands.Slash
/// </summary>
internal class SlashThemeTramontina : ApplicationCommandModule
{

/// <summary>
/// Represents the asynchronous slash reset theme method called when user asks for the slash reset theme command.
/// </summary>
/// <param name="interactionContext">The interaction context from the current command call.</param>
/// <returns>A <see cref="Task"/> from the current asynchronous task.</returns>
[SlashCommand("theme-reset", "Volta o tema do servidor para o Padrão!!")]
[SlashRequireUserPermissions(Permissions.Administrator)]
internal static async Task ExecuteSlashResetAsync(InteractionContext interactionContext)
Expand All @@ -25,6 +29,11 @@ internal static async Task ExecuteSlashResetAsync(InteractionContext interaction
await interactionContext.DeleteResponseAsync();
}

/// <summary>
/// Represents the asynchronous slash christmas theme method called when user asks for the slash christmas theme command.
/// </summary>
/// <param name="interactionContext">The interaction context from the current command call.</param>
/// <returns>A <see cref="Task"/> from the current asynchronous task.</returns>
[SlashCommand("theme-christmas", "🎅🏻 Define o tema do servidor para o de Natal!!")]
[SlashRequireUserPermissions(Permissions.Administrator)]
internal static async Task ExecuteSlashChristmasAsync(InteractionContext interactionContext)
Expand All @@ -39,6 +48,11 @@ internal static async Task ExecuteSlashChristmasAsync(InteractionContext interac
await interactionContext.DeleteResponseAsync();
}

/// <summary>
/// Represents the asynchronous slash easter theme method called when user asks for the slash easter theme command.
/// </summary>
/// <param name="interactionContext">The interaction context from the current command call.</param>
/// <returns>A <see cref="Task"/> from the current asynchronous task.</returns>
[SlashCommand("theme-easter", "🐇 Define o tema do servidor para o de Páscoa!!")]
[SlashRequireUserPermissions(Permissions.Administrator)]
internal static async Task ExecuteSlashEasterAsync(InteractionContext interactionContext)
Expand All @@ -53,6 +67,11 @@ internal static async Task ExecuteSlashEasterAsync(InteractionContext interactio
await interactionContext.DeleteResponseAsync();
}

/// <summary>
/// Represents the asynchronous slash halloween theme method called when user asks for the slash halloween theme command.
/// </summary>
/// <param name="interactionContext">The interaction context from the current command call.</param>
/// <returns>A <see cref="Task"/> from the current asynchronous task.</returns>
[SlashCommand("theme-halloween", "🎃 Define o tema do servidor para o de Halloween!!")]
[SlashRequireUserPermissions(Permissions.Administrator)]
internal static async Task ExecuteSlashHalloweenAsync(InteractionContext interactionContext)
Expand Down
123 changes: 123 additions & 0 deletions src/KWIJisho-doc.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 4bbab2d

Please sign in to comment.