From b4f986031959172b4c66b9a3bc1d0b19ccc47bc5 Mon Sep 17 00:00:00 2001
From: Hsu Still <341464@gmail.com>
Date: Wed, 21 Mar 2018 15:27:22 +0800
Subject: [PATCH] Add XMLDocs
+ GameAsset
+ GameTimestamps
+ Format
---
src/Discord.Net.Core/Entities/Activities/GameAsset.cs | 8 ++++++--
src/Discord.Net.Core/Entities/Activities/GameTimestamps.cs | 5 +++--
src/Discord.Net.Core/Format.cs | 3 ++-
3 files changed, 11 insertions(+), 5 deletions(-)
diff --git a/src/Discord.Net.Core/Entities/Activities/GameAsset.cs b/src/Discord.Net.Core/Entities/Activities/GameAsset.cs
index 02c29ba41..ee084235d 100644
--- a/src/Discord.Net.Core/Entities/Activities/GameAsset.cs
+++ b/src/Discord.Net.Core/Entities/Activities/GameAsset.cs
@@ -1,14 +1,18 @@
namespace Discord
{
+ /// The asset for a object.
public class GameAsset
{
internal GameAsset() { }
internal ulong? ApplicationId { get; set; }
-
+
+ /// The description of the asset.
public string Text { get; internal set; }
+ /// The image ID of the asset.
public string ImageId { get; internal set; }
-
+
+ /// The image URL of the asset; may return null when the application ID does not exist.
public string GetImageUrl(ImageFormat format = ImageFormat.Auto, ushort size = 128)
=> ApplicationId.HasValue ? CDN.GetRichAssetUrl(ApplicationId.Value, ImageId, size, format) : null;
}
diff --git a/src/Discord.Net.Core/Entities/Activities/GameTimestamps.cs b/src/Discord.Net.Core/Entities/Activities/GameTimestamps.cs
index 8c8c992fa..846832796 100644
--- a/src/Discord.Net.Core/Entities/Activities/GameTimestamps.cs
+++ b/src/Discord.Net.Core/Entities/Activities/GameTimestamps.cs
@@ -1,7 +1,8 @@
-using System;
+using System;
namespace Discord
{
+ /// The timestamps for a object.
public class GameTimestamps
{
public DateTimeOffset? Start { get; }
@@ -13,4 +14,4 @@ namespace Discord
End = end;
}
}
-}
\ No newline at end of file
+}
diff --git a/src/Discord.Net.Core/Format.cs b/src/Discord.Net.Core/Format.cs
index aa822f99e..beb13b6d8 100644
--- a/src/Discord.Net.Core/Format.cs
+++ b/src/Discord.Net.Core/Format.cs
@@ -1,5 +1,6 @@
-namespace Discord
+namespace Discord
{
+ /// A helper class for formatting characters.
public static class Format
{
// Characters which need escaping