From 199bcd6b26f3ffc8561a9570121a9e1ec0236a1b Mon Sep 17 00:00:00 2001 From: Still Hsu <341464@gmail.com> Date: Wed, 11 Jul 2018 18:48:54 +0800 Subject: [PATCH] Add XML doc --- .../Entities/ISnowflakeEntity.cs | 7 ++++- .../Entities/Guilds/SocketGuild.cs | 26 +++++++++++++------ .../Entities/SocketEntity.cs | 3 ++- 3 files changed, 26 insertions(+), 10 deletions(-) diff --git a/src/Discord.Net.Core/Entities/ISnowflakeEntity.cs b/src/Discord.Net.Core/Entities/ISnowflakeEntity.cs index f5dd2ab07..9c7b3721f 100644 --- a/src/Discord.Net.Core/Entities/ISnowflakeEntity.cs +++ b/src/Discord.Net.Core/Entities/ISnowflakeEntity.cs @@ -5,7 +5,12 @@ namespace Discord /// Represents a Discord snowflake entity. public interface ISnowflakeEntity : IEntity { - /// Gets when the snowflake is created. + /// + /// Gets when the snowflake is created. + /// + /// + /// A representing when the entity was first created. + /// DateTimeOffset CreatedAt { get; } } } diff --git a/src/Discord.Net.WebSocket/Entities/Guilds/SocketGuild.cs b/src/Discord.Net.WebSocket/Entities/Guilds/SocketGuild.cs index 081e184a2..c095f0e03 100644 --- a/src/Discord.Net.WebSocket/Entities/Guilds/SocketGuild.cs +++ b/src/Discord.Net.WebSocket/Entities/Guilds/SocketGuild.cs @@ -56,11 +56,15 @@ namespace Discord.WebSocket /// /// This property retrieves the number of members returned by Discord. /// + /// /// Due to how this property is returned by Discord instead of relying on the WebSocket cache, the - /// number here is the most accurate in terms of counting the number of users within this guild. Use - /// this instead of enumerating the count of the - /// collection, as you may see discrepancy between the count of - /// collection and this property. + /// number here is the most accurate in terms of counting the number of users within this guild. + /// + /// + /// Use this instead of enumerating the count of the + /// collection, as you may see discrepancy + /// between that and this property. + /// /// /// public int MemberCount { get; internal set; } @@ -220,10 +224,16 @@ namespace Discord.WebSocket /// /// This property retrieves all users found within this guild. /// - /// This property may not always return all the members for large guilds (i.e. guilds containing 100+ users). - /// If you are simply looking to get the number of users present in this guild, consider instead. - /// Otherwise, you may need to enable to fetch the full user list - /// upon startup, or use to manually download the users. + /// + /// This property may not always return all the members for large guilds (i.e. guilds containing + /// 100+ users). If you are simply looking to get the number of users present in this guild, + /// consider using instead. + /// + /// + /// Otherwise, you may need to enable to fetch + /// the full user list upon startup, or use to manually download + /// the users. + /// /// /// /// diff --git a/src/Discord.Net.WebSocket/Entities/SocketEntity.cs b/src/Discord.Net.WebSocket/Entities/SocketEntity.cs index c8e14fb6c..f76694e6f 100644 --- a/src/Discord.Net.WebSocket/Entities/SocketEntity.cs +++ b/src/Discord.Net.WebSocket/Entities/SocketEntity.cs @@ -1,4 +1,4 @@ -using System; +using System; namespace Discord.WebSocket { @@ -6,6 +6,7 @@ namespace Discord.WebSocket where T : IEquatable { internal DiscordSocketClient Discord { get; } + /// public T Id { get; } internal SocketEntity(DiscordSocketClient discord, T id)