Skip to content

Commit

Permalink
Replace all langword placements with code block
Browse files Browse the repository at this point in the history
  • Loading branch information
Still Hsu committed May 6, 2018
1 parent ac47d84 commit 1bb06cc
Show file tree
Hide file tree
Showing 28 changed files with 129 additions and 125 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ public abstract class PreconditionAttribute : Attribute
/// </summary>
/// <remarks>
/// <see cref="Preconditions" /> of the same group require only one of the preconditions to pass in order to
/// be successful (A || B). Specifying <see cref="Group" /> = <see langword="null" /> or not at all will
/// be successful (A || B). Specifying <see cref="Group" /> = <c>null</c> or not at all will
/// require *all* preconditions to pass, just like normal (A &amp;&amp; B).
/// </remarks>
public string Group { get; set; } = null;
Expand Down
6 changes: 3 additions & 3 deletions src/Discord.Net.Commands/CommandService.cs
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ public async Task<ModuleInfo> CreateModuleAsync(string primaryAlias, Action<Modu
/// <typeparam name="T">The type of module.</typeparam>
/// <param name="services">
/// The <see cref="IServiceProvider" /> for your dependency injection solution, if using one - otherwise, pass
/// <see langword="null" />.
/// <c>null</c>.
/// </param>
/// <returns>
/// A built module.
Expand All @@ -144,7 +144,7 @@ public async Task<ModuleInfo> CreateModuleAsync(string primaryAlias, Action<Modu
/// <param name="type">The type of module.</param>
/// <param name="services">
/// The <see cref="IServiceProvider" /> for your dependency injection solution, if using one - otherwise, pass
/// <see langword="null" />.
/// <c>null</c>.
/// </param>
/// <returns>
/// A built module.
Expand Down Expand Up @@ -183,7 +183,7 @@ public async Task<ModuleInfo> AddModuleAsync(Type type, IServiceProvider service
/// <param name="assembly">The <see cref="Assembly" /> containing command modules.</param>
/// <param name="services">
/// An <see cref="IServiceProvider" /> for your dependency injection solution, if using one - otherwise, pass
/// <see langword="null" />.
/// <c>null</c>.
/// </param>
/// <returns>
/// A collection of built modules.
Expand Down
2 changes: 1 addition & 1 deletion src/Discord.Net.Commands/Results/RuntimeResult.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ public abstract class RuntimeResult : IResult
/// <summary>
/// Initializes a new <see cref="RuntimeResult" /> class with the type of error and reason.
/// </summary>
/// <param name="error">The type of failure, or <see langword="null" /> if none.</param>
/// <param name="error">The type of failure, or <c>null</c> if none.</param>
/// <param name="reason">The reason of failure.</param>
protected RuntimeResult(CommandError? error, string reason)
{
Expand Down
4 changes: 2 additions & 2 deletions src/Discord.Net.Core/Entities/Channels/IGuildChannel.cs
Original file line number Diff line number Diff line change
Expand Up @@ -63,10 +63,10 @@ public interface IGuildChannel : IChannel, IDeletable
/// The max amount of times this invite may be used. Set to <c>null</c> to have unlimited uses.
/// </param>
/// <param name="isTemporary">
/// If <see langword="true"/>, a user accepting this invite will be kicked from the guild after closing their client.
/// If <c>true</c>, a user accepting this invite will be kicked from the guild after closing their client.
/// </param>
/// <param name="isUnique">
/// If <see langword="true"/>, don't try to reuse a similar invite (useful for creating many unique one time use invites).
/// If <c>true</c>, don't try to reuse a similar invite (useful for creating many unique one time use invites).
/// </param>
/// <param name="options">
/// The options to be used when sending the request.
Expand Down
2 changes: 1 addition & 1 deletion src/Discord.Net.Core/Entities/Channels/ITextChannel.cs
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ public interface ITextChannel : IMessageChannel, IMentionable, IGuildChannel
/// Determines whether the channel is NSFW.
/// </summary>
/// <returns>
/// <see langword="true"/> if the channel has the NSFW flag enabled; otherwise, <see langword="false"/>.
/// <c>true</c> if the channel has the NSFW flag enabled; otherwise, <c>false</c>.
/// </returns>
bool IsNsfw { get; }

Expand Down
24 changes: 14 additions & 10 deletions src/Discord.Net.Core/Entities/Guilds/IGuild.cs
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ public interface IGuild : IDeletable, ISnowflakeEntity
/// Determines if this guild is embeddable (i.e. can use widget).
/// </summary>
/// <returns>
/// <see langword="true"/> if this guild can be embedded via widgets; otherwise <see langword="false"/>.
/// <c>true</c> if this guild can be embedded via widgets; otherwise <c>false</c>.
/// </returns>
bool IsEmbeddable { get; }
/// <summary>
Expand Down Expand Up @@ -59,7 +59,7 @@ public interface IGuild : IDeletable, ISnowflakeEntity
/// Determines if this guild is currently connected and ready to be used.
/// </summary>
/// <returns>
/// Returns <see langword="true"/> if this guild is currently connected and ready to be used. Only applies
/// Returns <c>true</c> if this guild is currently connected and ready to be used. Only applies
/// to the WebSocket client.
/// </returns>
bool Available { get; }
Expand Down Expand Up @@ -260,7 +260,7 @@ public interface IGuild : IDeletable, ISnowflakeEntity
/// </returns>
Task<IReadOnlyCollection<ITextChannel>> GetTextChannelsAsync(CacheMode mode = CacheMode.AllowDownload, RequestOptions options = null);
/// <summary>
/// Gets a text channel in this guild with the provided ID, or <see langword="null" /> if not found.
/// Gets a text channel in this guild with the provided ID, or <c>null</c> if not found.
/// </summary>
/// <param name="id">The text channel ID.</param>
/// <param name="mode">
Expand Down Expand Up @@ -328,7 +328,7 @@ public interface IGuild : IDeletable, ISnowflakeEntity
/// <param name="options">The options to be used when sending the request.</param>
/// <returns>
/// An awaitable <see cref="Task"/> containing the system channel within this guild, or
/// <see langword="null" /> if none is set.
/// <c>null</c> if none is set.
/// </returns>
Task<ITextChannel> GetSystemChannelAsync(CacheMode mode = CacheMode.AllowDownload, RequestOptions options = null);
/// <summary>
Expand Down Expand Up @@ -459,25 +459,29 @@ public interface IGuild : IDeletable, ISnowflakeEntity
/// </returns>
Task DownloadUsersAsync();
/// <summary>
/// Removes all users from this guild if they have not logged on in a provided number of
/// <paramref name="days" /> or, if <paramref name="simulate" /> is <see langword="true"/>, returns the
/// number of users that would be removed.
/// Prunes inactive users.
/// </summary>
/// <remarks>
/// This method removes all users that have not logged on in the provided number of days or, if
/// <paramref name="simulate"/> is <c>true</c>, returns the number of users that would be removed.
/// </remarks>
/// <param name="days">The number of days required for the users to be kicked.</param>
/// <param name="simulate">Whether this prune action is a simulation.</param>
/// <param name="options">The options to be used when sending the request.</param>
/// <returns>
/// An awaitable <see cref="Task"/> containing the number of users to be or has been removed from this guild.
/// An awaitable <see cref="Task" /> containing the number of users to be or has been removed from this
/// guild.
/// </returns>
Task<int> PruneUsersAsync(int days = 30, bool simulate = false, RequestOptions options = null);

/// <summary>
/// Gets the webhook in this guild with the provided ID, or <c>null</c> if not found.
/// Gets a webhook found within this guild.
/// </summary>
/// <param name="id">The webhook ID.</param>
/// <param name="options">The options to be used when sending the request.</param>
/// <returns>
/// An awaitable <see cref="Task"/> containing the webhook with the specified ID, otherwise <c>null</c>.
/// An awaitable <see cref="Task"/> containing the webhook with the specified ID; <c>null</c> if none is
/// found.
/// </returns>
Task<IWebhook> GetWebhookAsync(ulong id, RequestOptions options = null);
/// <summary>
Expand Down
2 changes: 1 addition & 1 deletion src/Discord.Net.Core/Entities/Guilds/IUserGuild.cs
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ public interface IUserGuild : IDeletable, ISnowflakeEntity
/// </summary>
string IconUrl { get; }
/// <summary>
/// Returns <see langword="true"/> if the current user owns this guild.
/// Returns <c>true</c> if the current user owns this guild.
/// </summary>
bool IsOwner { get; }
/// <summary>
Expand Down
8 changes: 4 additions & 4 deletions src/Discord.Net.Core/Entities/Guilds/IVoiceRegion.cs
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,19 @@ public interface IVoiceRegion
/// </summary>
string Name { get; }
/// <summary>
/// Returns <see langword="true"/> if this voice region is exclusive to VIP accounts.
/// Returns <c>true</c> if this voice region is exclusive to VIP accounts.
/// </summary>
bool IsVip { get; }
/// <summary>
/// Returns <see langword="true"/> if this voice region is the closest to your machine.
/// Returns <c>true</c> if this voice region is the closest to your machine.
/// </summary>
bool IsOptimal { get; }
/// <summary>
/// Returns <see langword="true"/> if this is a deprecated voice region (avoid switching to these).
/// Returns <c>true</c> if this is a deprecated voice region (avoid switching to these).
/// </summary>
bool IsDeprecated { get; }
/// <summary>
/// Returns <see langword="true"/> if this is a custom voice region (used for events/etc).
/// Returns <c>true</c> if this is a custom voice region (used for events/etc).
/// </summary>
bool IsCustom { get; }
}
Expand Down
2 changes: 1 addition & 1 deletion src/Discord.Net.Core/Entities/Image.cs
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ public Image(Stream stream)
/// <paramref name="path" /> is a zero-length string, contains only white space, or contains one or more invalid
/// characters as defined by <see cref="Path.GetInvalidPathChars" />.
/// </exception>
/// <exception cref="ArgumentNullException"><paramref name="path" /> is <see langword="null" />.</exception>
/// <exception cref="ArgumentNullException"><paramref name="path" /> is <c>null</c>.</exception>
/// <exception cref="PathTooLongException">
/// The specified path, file name, or both exceed the system-defined maximum length. For example, on
/// Windows-based platforms, paths must be less than 248 characters, and file names must be less than 260
Expand Down
4 changes: 2 additions & 2 deletions src/Discord.Net.Core/Entities/Invites/IInviteMetadata.cs
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ public interface IInviteMetadata : IInvite
/// </summary>
IUser Inviter { get; }
/// <summary>
/// Returns <see langword="true"/> if this invite was revoked.
/// Returns <c>true</c> if this invite was revoked.
/// </summary>
bool IsRevoked { get; }
/// <summary>
/// Returns <see langword="true"/> if users accepting this invite will be removed from the guild when they
/// Returns <c>true</c> if users accepting this invite will be removed from the guild when they
/// log off.
/// </summary>
bool IsTemporary { get; }
Expand Down
14 changes: 7 additions & 7 deletions src/Discord.Net.Core/Entities/Messages/EmbedBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -125,28 +125,28 @@ public List<EmbedFieldBuilder> Fields
/// Gets or sets the timestamp of an <see cref="Embed" />.
/// </summary>
/// <returns>
/// The timestamp of the embed, or <see langword="null" /> if none is set.
/// The timestamp of the embed, or <c>null</c> if none is set.
/// </returns>
public DateTimeOffset? Timestamp { get; set; }
/// <summary>
/// Gets or sets the sidebar color of an <see cref="Embed" />.
/// </summary>
/// <returns>
/// The color of the embed, or <see langword="null" /> if none is set.
/// The color of the embed, or <c>null</c> if none is set.
/// </returns>
public Color? Color { get; set; }
/// <summary>
/// Gets or sets the <see cref="EmbedAuthorBuilder" /> of an <see cref="Embed" />.
/// </summary>
/// <returns>
/// The author field builder of the embed, or <see langword="null" /> if none is set.
/// The author field builder of the embed, or <c>null</c> if none is set.
/// </returns>
public EmbedAuthorBuilder Author { get; set; }
/// <summary>
/// Gets or sets the <see cref="EmbedFooterBuilder" /> of an <see cref="Embed" />.
/// </summary>
/// <returns>
/// The footer field builder of the embed, or <see langword="null" /> if none is set.
/// The footer field builder of the embed, or <c>null</c> if none is set.
/// </returns>
public EmbedFooterBuilder Footer { get; set; }

Expand Down Expand Up @@ -452,7 +452,7 @@ public class EmbedFieldBuilder
/// Gets or sets the field name.
/// </summary>
/// <exception cref="ArgumentException">
/// <para>Field name is <see langword="null" />, empty or entirely whitespace.</para>
/// <para>Field name is <c>null</c>, empty or entirely whitespace.</para>
/// <para><c>- or -</c></para>
/// <para>Field name length exceeds <see cref="MaxFieldNameLength"/>.</para>
/// </exception>
Expand All @@ -474,7 +474,7 @@ public string Name
/// Gets or sets the field value.
/// </summary>
/// <exception cref="ArgumentException" accessor="set">
/// <para>Field value is <see langword="null" />, empty or entirely whitespace.</para>
/// <para>Field value is <c>null</c>, empty or entirely whitespace.</para>
/// <para><c>- or -</c></para>
/// <para>Field value length exceeds <see cref="MaxFieldValueLength"/>.</para>
/// </exception>
Expand Down Expand Up @@ -540,7 +540,7 @@ public EmbedFieldBuilder WithIsInline(bool isInline)
/// The current builder.
/// </returns>
/// <exception cref="ArgumentException">
/// <para><see cref="Name"/> or <see cref="Value"/> is <see langword="null" />, empty or entirely whitespace.</para>
/// <para><see cref="Name"/> or <see cref="Value"/> is <c>null</c>, empty or entirely whitespace.</para>
/// <para><c>- or -</c></para>
/// <para><see cref="Name"/> or <see cref="Value"/> exceeds the maximum length allowed by Discord.</para>
/// </exception>
Expand Down
16 changes: 8 additions & 8 deletions src/Discord.Net.Core/Entities/Messages/IEmbed.cs
Original file line number Diff line number Diff line change
Expand Up @@ -41,56 +41,56 @@ public interface IEmbed
/// </summary>
/// <returns>
/// A <see cref="DateTimeOffset"/> based on the timestamp present at the bottom left of the embed, or
/// <see langword="null" /> if none is set.
/// <c>null</c> if none is set.
/// </returns>
DateTimeOffset? Timestamp { get; }
/// <summary>
/// Gets the color of this embed.
/// </summary>
/// <returns>
/// The color of the embed present on the side of the embed, or <see langword="null" /> if none is set.
/// The color of the embed present on the side of the embed, or <c>null</c> if none is set.
/// </returns>
Color? Color { get; }
/// <summary>
/// Gets the image of this embed.
/// </summary>
/// <returns>
/// The image of the embed, or <see langword="null" /> if none is set.
/// The image of the embed, or <c>null</c> if none is set.
/// </returns>
EmbedImage? Image { get; }
/// <summary>
/// Gets the video of this embed.
/// </summary>
/// <returns>
/// The video of the embed, or <see langword="null" /> if none is set.
/// The video of the embed, or <c>null</c> if none is set.
/// </returns>
EmbedVideo? Video { get; }
/// <summary>
/// Gets the author field of this embed.
/// </summary>
/// <returns>
/// The author field of the embed, or <see langword="null" /> if none is set.
/// The author field of the embed, or <c>null</c> if none is set.
/// </returns>
EmbedAuthor? Author { get; }
/// <summary>
/// Gets the footer field of this embed.
/// </summary>
/// <returns>
/// The author field of the embed, or <see langword="null" /> if none is set.
/// The author field of the embed, or <c>null</c> if none is set.
/// </returns>
EmbedFooter? Footer { get; }
/// <summary>
/// Gets the provider of this embed.
/// </summary>
/// <returns>
/// The source of the embed, or <see langword="null" /> if none is set.
/// The source of the embed, or <c>null</c> if none is set.
/// </returns>
EmbedProvider? Provider { get; }
/// <summary>
/// Gets the thumbnail featured in this embed.
/// </summary>
/// <returns>
/// The thumbnail featured in the embed, or <see langword="null" /> if none is set.
/// The thumbnail featured in the embed, or <c>null</c> if none is set.
/// </returns>
EmbedThumbnail? Thumbnail { get; }
/// <summary>
Expand Down
4 changes: 2 additions & 2 deletions src/Discord.Net.Core/Entities/Messages/IMessage.cs
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@ public interface IMessage : ISnowflakeEntity, IDeletable
/// </summary>
MessageSource Source { get; }
/// <summary>
/// Returns <see langword="true"/> if this message was sent as a text-to-speech message.
/// Returns <c>true</c> if this message was sent as a text-to-speech message.
/// </summary>
bool IsTTS { get; }
/// <summary>
/// Returns <see langword="true"/> if this message was added to its channel's pinned messages.
/// Returns <c>true</c> if this message was added to its channel's pinned messages.
/// </summary>
bool IsPinned { get; }
/// <summary>
Expand Down
2 changes: 1 addition & 1 deletion src/Discord.Net.Core/Entities/Messages/ReactionMetadata.cs
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ public struct ReactionMetadata
public int ReactionCount { get; internal set; }

/// <summary>
/// Returns <see langword="true"/> if the current user has used this reaction.
/// Returns <c>true</c> if the current user has used this reaction.
/// </summary>
public bool IsMe { get; internal set; }
}
Expand Down
Loading

0 comments on commit 1bb06cc

Please sign in to comment.