From 180b20dd02edddfe1d279348516f5d54985eb8f0 Mon Sep 17 00:00:00 2001
From: Still Hsu <341464@gmail.com>
Date: Sun, 27 May 2018 18:19:20 +0800
Subject: [PATCH] Add documentation for new INestedChannel
---
.../Entities/Channels/INestedChannel.cs | 20 +++++++++++++++----
1 file changed, 16 insertions(+), 4 deletions(-)
diff --git a/src/Discord.Net.Core/Entities/Channels/INestedChannel.cs b/src/Discord.Net.Core/Entities/Channels/INestedChannel.cs
index c8d2bcaaf..9c66fb06c 100644
--- a/src/Discord.Net.Core/Entities/Channels/INestedChannel.cs
+++ b/src/Discord.Net.Core/Entities/Channels/INestedChannel.cs
@@ -3,14 +3,26 @@ using System.Threading.Tasks;
namespace Discord
{
///
- /// A type of guild channel that can be nested within a category.
- /// Contains a CategoryId that is set to the parent category, if it is set.
+ /// Represents a type of guild channel that can be nested within a category.
///
public interface INestedChannel : IGuildChannel
{
- /// Gets the parentid (category) of this channel in the guild's channel list.
+ ///
+ /// Gets the parent (category) ID of this channel in the guild's channel list.
+ ///
+ ///
+ /// An representing the snowflake identifier of the parent of this channel;
+ /// null if none is set.
+ ///
ulong? CategoryId { get; }
- /// Gets the parent channel (category) of this channel, if it is set. If unset, returns null.
+ ///
+ /// Gets the parent (category) channel of this channel.
+ ///
+ /// The that determines whether the object should be fetched from cache.
+ /// The options to be used when sending the request.
+ ///
+ /// A generic category channel representing the parent of this channel; null if none is set.
+ ///
Task GetCategoryAsync(CacheMode mode = CacheMode.AllowDownload, RequestOptions options = null);
}
}