Browse Source

Added some class summaries

pull/1161/head
Casino Boyale 7 years ago
parent
commit
2f41896cdf
16 changed files with 52 additions and 0 deletions
  1. +3
    -0
      src/Discord.Net.Commands/Attributes/RemarksAttribute.cs
  2. +3
    -0
      src/Discord.Net.Commands/Attributes/SummaryAttribute.cs
  3. +3
    -0
      src/Discord.Net.Commands/Info/ModuleInfo.cs
  4. +3
    -0
      src/Discord.Net.Commands/Info/ParameterInfo.cs
  5. +7
    -0
      src/Discord.Net.Commands/ModuleBase.cs
  6. +3
    -0
      src/Discord.Net.Rest/Entities/Channels/RestGroupChannel.cs
  7. +3
    -0
      src/Discord.Net.Rest/Entities/Guilds/RestVoiceRegion.cs
  8. +3
    -0
      src/Discord.Net.Rest/Entities/Messages/RestMessage.cs
  9. +3
    -0
      src/Discord.Net.Rest/Entities/Messages/RestSystemMessage.cs
  10. +3
    -0
      src/Discord.Net.Rest/Entities/Messages/RestUserMessage.cs
  11. +3
    -0
      src/Discord.Net.Rest/Entities/Roles/RestRole.cs
  12. +3
    -0
      src/Discord.Net.Rest/Entities/Users/RestGroupUser.cs
  13. +3
    -0
      src/Discord.Net.Rest/Entities/Users/RestGuildUser.cs
  14. +3
    -0
      src/Discord.Net.Rest/Entities/Users/RestSelfUser.cs
  15. +3
    -0
      src/Discord.Net.Rest/Entities/Users/RestUser.cs
  16. +3
    -0
      src/Discord.Net.WebSocket/Entities/Users/SocketWebhookUser.cs

+ 3
- 0
src/Discord.Net.Commands/Attributes/RemarksAttribute.cs View File

@@ -3,6 +3,9 @@ using System;
namespace Discord.Commands namespace Discord.Commands
{ {
// Extension of the Cosmetic Summary, for Groups, Commands, and Parameters // Extension of the Cosmetic Summary, for Groups, Commands, and Parameters
/// <summary>
/// An attribute that allows you to attach remarks to your command.
/// </summary>
[AttributeUsage(AttributeTargets.Method | AttributeTargets.Class, AllowMultiple = false, Inherited = true)] [AttributeUsage(AttributeTargets.Method | AttributeTargets.Class, AllowMultiple = false, Inherited = true)]
public class RemarksAttribute : Attribute public class RemarksAttribute : Attribute
{ {


+ 3
- 0
src/Discord.Net.Commands/Attributes/SummaryAttribute.cs View File

@@ -3,6 +3,9 @@ using System;
namespace Discord.Commands namespace Discord.Commands
{ {
// Cosmetic Summary, for Groups and Commands // Cosmetic Summary, for Groups and Commands
/// <summary>
/// An attribute that allows you to attach a summary to your command.
/// </summary>
[AttributeUsage(AttributeTargets.Method | AttributeTargets.Class | AttributeTargets.Parameter, AllowMultiple = false, Inherited = true)] [AttributeUsage(AttributeTargets.Method | AttributeTargets.Class | AttributeTargets.Parameter, AllowMultiple = false, Inherited = true)]
public class SummaryAttribute : Attribute public class SummaryAttribute : Attribute
{ {


+ 3
- 0
src/Discord.Net.Commands/Info/ModuleInfo.cs View File

@@ -6,6 +6,9 @@ using Discord.Commands.Builders;


namespace Discord.Commands namespace Discord.Commands
{ {
/// <summary>
/// Provides the information of a module.
/// </summary>
public class ModuleInfo public class ModuleInfo
{ {
public CommandService Service { get; } public CommandService Service { get; }


+ 3
- 0
src/Discord.Net.Commands/Info/ParameterInfo.cs View File

@@ -7,6 +7,9 @@ using System.Threading.Tasks;


namespace Discord.Commands namespace Discord.Commands
{ {
/// <summary>
/// Provides the information of a parameter.
/// </summary>
[DebuggerDisplay(@"{DebuggerDisplay,nq}")] [DebuggerDisplay(@"{DebuggerDisplay,nq}")]
public class ParameterInfo public class ParameterInfo
{ {


+ 7
- 0
src/Discord.Net.Commands/ModuleBase.cs View File

@@ -4,8 +4,15 @@ using Discord.Commands.Builders;


namespace Discord.Commands namespace Discord.Commands
{ {
/// <summary>
/// The base class that command modules inherit from where the context is of type <see cref="ICommandContext"/>.
/// </summary>
public abstract class ModuleBase : ModuleBase<ICommandContext> { } public abstract class ModuleBase : ModuleBase<ICommandContext> { }


/// <summary>
/// The base class that command modules inherit from.
/// </summary>
/// <typeparam name="T">A class that implements <see cref="ICommandContext"/>.</typeparam>
public abstract class ModuleBase<T> : IModuleBase public abstract class ModuleBase<T> : IModuleBase
where T : class, ICommandContext where T : class, ICommandContext
{ {


+ 3
- 0
src/Discord.Net.Rest/Entities/Channels/RestGroupChannel.cs View File

@@ -10,6 +10,9 @@ using Model = Discord.API.Channel;


namespace Discord.Rest namespace Discord.Rest
{ {
/// <summary>
/// Represents a REST-based group-message channel.
/// </summary>
[DebuggerDisplay(@"{DebuggerDisplay,nq}")] [DebuggerDisplay(@"{DebuggerDisplay,nq}")]
public class RestGroupChannel : RestChannel, IGroupChannel, IRestPrivateChannel, IRestMessageChannel, IRestAudioChannel public class RestGroupChannel : RestChannel, IGroupChannel, IRestPrivateChannel, IRestMessageChannel, IRestAudioChannel
{ {


+ 3
- 0
src/Discord.Net.Rest/Entities/Guilds/RestVoiceRegion.cs View File

@@ -4,6 +4,9 @@ using Model = Discord.API.VoiceRegion;


namespace Discord namespace Discord
{ {
/// <summary>
/// Represents a REST-based voice region.
/// </summary>
[DebuggerDisplay("{DebuggerDisplay,nq}")] [DebuggerDisplay("{DebuggerDisplay,nq}")]
public class RestVoiceRegion : RestEntity<string>, IVoiceRegion public class RestVoiceRegion : RestEntity<string>, IVoiceRegion
{ {


+ 3
- 0
src/Discord.Net.Rest/Entities/Messages/RestMessage.cs View File

@@ -7,6 +7,9 @@ using Model = Discord.API.Message;


namespace Discord.Rest namespace Discord.Rest
{ {
/// <summary>
/// Represents a REST-based message.
/// </summary>
public abstract class RestMessage : RestEntity<ulong>, IMessage, IUpdateable public abstract class RestMessage : RestEntity<ulong>, IMessage, IUpdateable
{ {
private long _timestampTicks; private long _timestampTicks;


+ 3
- 0
src/Discord.Net.Rest/Entities/Messages/RestSystemMessage.cs View File

@@ -3,6 +3,9 @@ using Model = Discord.API.Message;


namespace Discord.Rest namespace Discord.Rest
{ {
/// <summary>
/// Represents a REST-based system message.
/// </summary>
[DebuggerDisplay(@"{DebuggerDisplay,nq}")] [DebuggerDisplay(@"{DebuggerDisplay,nq}")]
public class RestSystemMessage : RestMessage, ISystemMessage public class RestSystemMessage : RestMessage, ISystemMessage
{ {


+ 3
- 0
src/Discord.Net.Rest/Entities/Messages/RestUserMessage.cs View File

@@ -8,6 +8,9 @@ using Model = Discord.API.Message;


namespace Discord.Rest namespace Discord.Rest
{ {
/// <summary>
/// Represents a REST-based message sent by a user.
/// </summary>
[DebuggerDisplay(@"{DebuggerDisplay,nq}")] [DebuggerDisplay(@"{DebuggerDisplay,nq}")]
public class RestUserMessage : RestMessage, IUserMessage public class RestUserMessage : RestMessage, IUserMessage
{ {


+ 3
- 0
src/Discord.Net.Rest/Entities/Roles/RestRole.cs View File

@@ -5,6 +5,9 @@ using Model = Discord.API.Role;


namespace Discord.Rest namespace Discord.Rest
{ {
/// <summary>
/// Represents a REST-based role.
/// </summary>
[DebuggerDisplay(@"{DebuggerDisplay,nq}")] [DebuggerDisplay(@"{DebuggerDisplay,nq}")]
public class RestRole : RestEntity<ulong>, IRole public class RestRole : RestEntity<ulong>, IRole
{ {


+ 3
- 0
src/Discord.Net.Rest/Entities/Users/RestGroupUser.cs View File

@@ -3,6 +3,9 @@ using Model = Discord.API.User;


namespace Discord.Rest namespace Discord.Rest
{ {
/// <summary>
/// Represents a REST-based group user.
/// </summary>
[DebuggerDisplay(@"{DebuggerDisplay,nq}")] [DebuggerDisplay(@"{DebuggerDisplay,nq}")]
public class RestGroupUser : RestUser, IGroupUser public class RestGroupUser : RestUser, IGroupUser
{ {


+ 3
- 0
src/Discord.Net.Rest/Entities/Users/RestGuildUser.cs View File

@@ -8,6 +8,9 @@ using Model = Discord.API.GuildMember;


namespace Discord.Rest namespace Discord.Rest
{ {
/// <summary>
/// Represents a REST-based guild user
/// </summary>
[DebuggerDisplay(@"{DebuggerDisplay,nq}")] [DebuggerDisplay(@"{DebuggerDisplay,nq}")]
public class RestGuildUser : RestUser, IGuildUser public class RestGuildUser : RestUser, IGuildUser
{ {


+ 3
- 0
src/Discord.Net.Rest/Entities/Users/RestSelfUser.cs View File

@@ -5,6 +5,9 @@ using Model = Discord.API.User;


namespace Discord.Rest namespace Discord.Rest
{ {
/// <summary>
/// Represents the logged-in REST-based user.
/// </summary>
[DebuggerDisplay(@"{DebuggerDisplay,nq}")] [DebuggerDisplay(@"{DebuggerDisplay,nq}")]
public class RestSelfUser : RestUser, ISelfUser public class RestSelfUser : RestUser, ISelfUser
{ {


+ 3
- 0
src/Discord.Net.Rest/Entities/Users/RestUser.cs View File

@@ -5,6 +5,9 @@ using Model = Discord.API.User;


namespace Discord.Rest namespace Discord.Rest
{ {
/// <summary>
/// Represents a REST-based user.
/// </summary>
[DebuggerDisplay(@"{DebuggerDisplay,nq}")] [DebuggerDisplay(@"{DebuggerDisplay,nq}")]
public class RestUser : RestEntity<ulong>, IUser, IUpdateable public class RestUser : RestEntity<ulong>, IUser, IUpdateable
{ {


+ 3
- 0
src/Discord.Net.WebSocket/Entities/Users/SocketWebhookUser.cs View File

@@ -7,6 +7,9 @@ using Model = Discord.API.User;


namespace Discord.WebSocket namespace Discord.WebSocket
{ {
/// <summary>
/// Represents a WebSocket-based webhook user.
/// </summary>
[DebuggerDisplay(@"{DebuggerDisplay,nq}")] [DebuggerDisplay(@"{DebuggerDisplay,nq}")]
public class SocketWebhookUser : SocketUser, IWebhookUser public class SocketWebhookUser : SocketUser, IWebhookUser
{ {


Loading…
Cancel
Save