Full documentation for ApplicationCommand*.cs files (#94)

* Full documentation for ApplicationCommand*.cs files

* fix newline

Co-authored-by: Kuba_Z2 <[email protected]>

* Changed documentation for ApplicationCommandInteractionData.cs

* Added note for autocomplete interactions

* Update NetCord/ApplicationCommandInteractionDataOption.cs

---------

Co-authored-by: Kuba_Z2 <[email protected]>

Author: Red-K0

NetCord/ApplicationCommandInteraction.cs

@@ -3,11 +3,17 @@
 
 namespace NetCord;
 
+/// <summary>
+/// Acts as a base class for application commands, such as slash commands and message commands.
+/// </summary>
 public abstract class ApplicationCommandInteraction : Interaction
 {
     private protected ApplicationCommandInteraction(JsonModels.JsonInteraction jsonModel, Guild? guild, Func<IInteraction, InteractionCallback, RestRequestProperties?, CancellationToken, Task> sendResponseAsync, RestClient client) : base(jsonModel, guild, sendResponseAsync, client)
     {
     }
 
+    /// <summary>
+    /// Holds the containing application command's data.
+    /// </summary>
     public abstract override ApplicationCommandInteractionData Data { get; }
 }

NetCord/ApplicationCommandInteractionData.cs

@@ -1,10 +1,22 @@
 namespace NetCord;
 
+/// <summary>
+/// Contains data for an invoked <see cref="Rest.ApplicationCommand"/>.
+/// </summary>
 public class ApplicationCommandInteractionData(JsonModels.JsonInteractionData jsonModel) : InteractionData(jsonModel)
 {
+    /// <summary>
+    /// The invoked <see cref="Rest.ApplicationCommand"/>'s ID.
+    /// </summary>
     public ulong Id => _jsonModel.Id.GetValueOrDefault();
 
+    /// <summary>
+    /// The invoked <see cref="Rest.ApplicationCommand"/>'s name.
+    /// </summary>
     public string Name => _jsonModel.Name!;
 
+    /// <summary>
+    /// The invoked <see cref="Rest.ApplicationCommand"/>'s type.
+    /// </summary>
     public ApplicationCommandType Type => _jsonModel.Type.GetValueOrDefault();
 }

NetCord/ApplicationCommandInteractionDataOption.cs

@@ -1,16 +1,34 @@
 namespace NetCord;
 
+/// <summary>
+/// Contains information on an <see cref="ApplicationCommandInteraction"/> parameter.
+/// </summary>
 public class ApplicationCommandInteractionDataOption(JsonModels.JsonApplicationCommandInteractionDataOption jsonModel) : IJsonModel<JsonModels.JsonApplicationCommandInteractionDataOption>
 {
     JsonModels.JsonApplicationCommandInteractionDataOption IJsonModel<JsonModels.JsonApplicationCommandInteractionDataOption>.JsonModel => jsonModel;
 
+    /// <summary>
+    /// The parameter's name.
+    /// </summary>
     public string Name => jsonModel.Name;
 
+    /// <summary>
+    /// The parameter's type.
+    /// </summary>
     public ApplicationCommandOptionType Type => jsonModel.Type;
 
+    /// <summary>
+    /// The parameter's value, <see langword="null"/> if omitted. When autocomplete is triggered for this parameter, the value is guaranteed to be non-<see langword="null"/>.
+    /// </summary>
     public string? Value => jsonModel.Value;
 
+    /// <summary>
+    /// A list of <see cref="ApplicationCommandInteractionDataOption"/> objects, if the option's <see cref="Type"/> is <see cref="ApplicationCommandOptionType.SubCommand"/> or <see cref="ApplicationCommandOptionType.SubCommandGroup"/>, otherwise empty.
+    /// </summary>
     public IReadOnlyList<ApplicationCommandInteractionDataOption>? Options { get; } = jsonModel.Options.SelectOrEmpty(o => new ApplicationCommandInteractionDataOption(o)).ToArray();
 
+    /// <summary>
+    /// If the user is currently typing in this option. Used for autocomplete interactions.
+    /// </summary>
     public bool Focused => jsonModel.Focused;
 }

NetCord/ApplicationCommandOptionType.cs

@@ -1,16 +1,68 @@
 namespace NetCord;
 
+/// <summary>
+/// Represents a command parameter's type.
+/// </summary>
 public enum ApplicationCommandOptionType
 {
+    /// <summary>
+    /// A sub-command.
+    /// </summary>
+    /// <remarks>
+    /// If present, the root <see cref="ApplicationCommandInteraction"/> can no longer be invoked.
+    /// </remarks>
     SubCommand = 1,
+
+    /// <summary>
+    /// A group of sub-commands.
+    /// </summary>
+    /// <remarks>
+    /// If present, the root <see cref="ApplicationCommandInteraction"/> can no longer be invoked.
+    /// </remarks>
     SubCommandGroup = 2,
+
+    /// <summary>
+    /// A <see cref="string"/> value.
+    /// </summary>
     String = 3,
+
+    /// <summary>
+    /// An integral number in the range <c>-2^53</c> to <c>2^53</c>.
+    /// </summary>
     Integer = 4,
+
+    /// <summary>
+    /// A <see langword="true"/> or <see langword="false"/> value.
+    /// </summary>
     Boolean = 5,
+
+    /// <summary>
+    /// Any user.
+    /// </summary>
     User = 6,
+
+    /// <summary>
+    /// Any channel or category in the current guild.
+    /// </summary>
     Channel = 7,
+
+    /// <summary>
+    /// Any role in the current guild.
+    /// </summary>
     Role = 8,
+
+    /// <summary>
+    /// Any role in the current guild, or any user.
+    /// </summary>
     Mentionable = 9,
+
+    /// <summary>
+    /// A floating point number in the range <c>-2^53</c> to <c>2^53</c>.
+    /// </summary>
     Double = 10,
+
+    /// <summary>
+    /// A <see cref="NetCord.Attachment"/> object.
+    /// </summary>
     Attachment = 11,
 }

NetCord/ApplicationCommandPermission.cs

@@ -1,12 +1,42 @@
 namespace NetCord;
 
+/// <summary>
+/// Represents a permission override for a command in a guild.
+/// </summary>
 public class ApplicationCommandPermission(JsonModels.JsonApplicationCommandGuildPermission jsonModel) : Entity, IJsonModel<JsonModels.JsonApplicationCommandGuildPermission>
 {
     JsonModels.JsonApplicationCommandGuildPermission IJsonModel<JsonModels.JsonApplicationCommandGuildPermission>.JsonModel => jsonModel;
 
+    /// <summary>
+    /// The ID of the override's relevant role, user, or channel, depending on the override's <see cref="Type"/>. May also be:
+    /// <list type="bullet">
+    ///     <item>
+    ///         <term>
+    ///         <see langword="@everyone"/>
+    ///         </term>
+    ///         <description>
+    ///         Where it is equal to the ID of the override's relevant guild.
+    ///         </description>
+    ///     </item>
+    ///     <item>
+    ///         <term>
+    ///         'All Channels'
+    ///         </term>
+    ///         <description>
+    ///         Where it is equal to the ID of the override's relevant guild - 1.
+    ///         </description>
+    ///     </item>
+    /// </list>
+    /// </summary>
     public override ulong Id => jsonModel.Id;
 
+    /// <summary>
+    /// Indicates the scope of the permission override.
+    /// </summary>
     public ApplicationCommandGuildPermissionType Type => jsonModel.Type;
 
+    /// <summary>
+    /// Indicates whether the override is intended to enable or disable a command.
+    /// </summary>
     public bool Permission => jsonModel.Permission;
 }

NetCord/ApplicationCommandPermissionType.cs

@@ -1,8 +1,22 @@
 namespace NetCord;
 
+/// <summary>
+/// Indicates the scope of an <see cref="ApplicationCommandPermission"/> object.
+/// </summary>
 public enum ApplicationCommandGuildPermissionType
 {
+    /// <summary>
+    /// Indicates that a permission is overriden for a specific role.
+    /// </summary>
     Role = 1,
+
+    /// <summary>
+    /// Indicates that a permission is overriden for a specific user.
+    /// </summary>
     User = 2,
+
+    /// <summary>
+    /// Indicates that a permission is overriden for a specific channel.
+    /// </summary>
     Channel = 3,
 }

NetCord/ApplicationCommandType.cs

@@ -1,8 +1,22 @@
 namespace NetCord;
 
+/// <summary>
+/// Indicates how a command is invoked client-side.
+/// </summary>
 public enum ApplicationCommandType
 {
+    /// <summary>
+    /// Slash command. Displayed when a user types <c>/</c> in chat.
+    /// </summary>
     ChatInput = 1,
+
+    /// <summary>
+    /// UI-based. Displayed when right clicking or tapping on a user.
+    /// </summary>
     User = 2,
+
+    /// <summary>
+    /// UI-based. Displayed when right clicking or tapping on a message.
+    /// </summary>
     Message = 3,
 }