docs: doc changes

This commit is contained in:
Lewdcario
2018-01-27 23:41:25 -06:00
parent d93d628f19
commit 2e0048add1
3 changed files with 5 additions and 4 deletions

View File

@@ -6,7 +6,7 @@ const GuildChannel = require('./GuildChannel');
*/ */
class CategoryChannel extends GuildChannel { class CategoryChannel extends GuildChannel {
/** /**
* Channels that are part of this category * Channels that are a part of this category
* @type {?Collection<Snowflake, GuildChannel>} * @type {?Collection<Snowflake, GuildChannel>}
* @readonly * @readonly
*/ */

View File

@@ -22,7 +22,7 @@ class GuildMember extends Base {
this.guild = guild; this.guild = guild;
/** /**
* The user that this guild member instance Represents * The user that this guild member instance represents
* @type {User} * @type {User}
*/ */
this.user = {}; this.user = {};
@@ -322,7 +322,7 @@ class GuildMember extends Base {
} }
/** /**
* Mute/unmutes a user. * Mutes/unmutes a user.
* @param {boolean} mute Whether or not the member should be muted * @param {boolean} mute Whether or not the member should be muted
* @param {string} [reason] Reason for muting or unmuting * @param {string} [reason] Reason for muting or unmuting
* @returns {Promise<GuildMember>} * @returns {Promise<GuildMember>}
@@ -332,7 +332,7 @@ class GuildMember extends Base {
} }
/** /**
* Deafen/undeafens a user. * Deafens/undeafens a user.
* @param {boolean} deaf Whether or not the member should be deafened * @param {boolean} deaf Whether or not the member should be deafened
* @param {string} [reason] Reason for deafening or undeafening * @param {string} [reason] Reason for deafening or undeafening
* @returns {Promise<GuildMember>} * @returns {Promise<GuildMember>}

View File

@@ -198,6 +198,7 @@ class Message extends Base {
* Represents the author of the message as a guild member. * Represents the author of the message as a guild member.
* Only available if the message comes from a guild where the author is still a member * Only available if the message comes from a guild where the author is still a member
* @type {?GuildMember} * @type {?GuildMember}
* @readonly
*/ */
get member() { get member() {
return this.guild ? this.guild.member(this.author) || null : null; return this.guild ? this.guild.member(this.author) || null : null;