Browse Source

Modify comments

pull/2284/head
Armano den Boef 3 years ago
parent
commit
39aed9d1bc
1 changed files with 9 additions and 5 deletions
  1. +9
    -5
      src/Discord.Net.Rest/Extensions/StringExtensions.cs

+ 9
- 5
src/Discord.Net.Rest/Extensions/StringExtensions.cs View File

@@ -4,14 +4,16 @@ using Newtonsoft.Json;
namespace Discord.Rest
{
/// <summary>
/// Responsible for formatting certain entities as json string, to reuse later on.
/// Responsible for formatting certain entities as Json <see langword="string"/>, to reuse later on.
/// </summary>
public static class StringExtensions
{
/// <summary>
/// Gets a Json formatted <see langword="string"/> from an <see cref="EmbedBuilder"/> to reuse.
/// See <see cref="EmbedBuilder.TryParse(string, out EmbedBuilder)"/> to parse Json back into embeds.
/// Gets a Json formatted <see langword="string"/> from an <see cref="EmbedBuilder"/>.
/// </summary>
/// <remarks>
/// See <see cref="EmbedBuilder.TryParse(string, out EmbedBuilder)"/> to parse Json back into embed.
/// </remarks>
/// <param name="builder">The builder to format as Json <see langword="string"/>.</param>
/// <param name="formatting">The formatting in which the Json will be returned.</param>
/// <returns>A Json <see langword="string"/> containing the data from the <paramref name="builder"/>.</returns>
@@ -19,9 +21,11 @@ namespace Discord.Rest
=> ToJsonString(builder.Build(), formatting);

/// <summary>
/// Gets a Json formatted <see langword="string"/> from an <see cref="Embed"/> to reuse.
/// See <see cref="EmbedBuilder.TryParse(string, out EmbedBuilder)"/> to parse Json back into embed.
/// Gets a Json formatted <see langword="string"/> from an <see cref="Embed"/>.
/// </summary>
/// <remarks>
/// See <see cref="EmbedBuilder.TryParse(string, out EmbedBuilder)"/> to parse Json back into embed.
/// </remarks>
/// <param name="embed">The embed to format as Json <see langword="string"/>.</param>
/// <param name="formatting">The formatting in which the Json will be returned.</param>
/// <returns>A Json <see langword="string"/> containing the data from the <paramref name="builder"/>.</returns>


Loading…
Cancel
Save