Nomchy/discord.js
1
0
Fork 0
mirror of https://github.com/discordjs/discord.js.git synced 2026-03-12 09:33:32 +01:00
Code Issues Packages Projects Releases Wiki Activity

Make JSDocs follow general conventions (#582)

Browse Source 
* Make JSDocs follow usual conventions

* Fix StringResolvable name

* Make function lowercase
This commit is contained in:
Schuyler Cebulskie
2016-09-03 04:57:25 -04:00
committed by Amish Shah
parent 44efcf3f52
commit 27652b94af
33 changed files with 262 additions and 262 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
src/structures/VoiceChannel.js
View File

@@ -10,7 +10,7 @@ class VoiceChannel extends GuildChannel {
super(guild, data);
/**
* The members in this Voice Channel.
* @type {Collection<String, GuildMember>}
* @type {Collection<string, GuildMember>}
*/
this.members = new Collection();
}
@@ -19,12 +19,12 @@ class VoiceChannel extends GuildChannel {
super.setup(data);
/**
* The bitrate of this voice channel
* @type {Number}
* @type {number}
*/
this.bitrate = data.bitrate;
/**
* The maximum amount of users allowed in this channel - 0 means unlimited.
* @type {Number}
* @type {number}
*/
this.userLimit = data.user_limit;
this.type = 'voice';
@@ -32,7 +32,7 @@ class VoiceChannel extends GuildChannel {
/**
* Sets the bitrate of the channel
* @param {Number} bitrate the new bitrate
* @param {number} bitrate the new bitrate
* @returns {Promise<VoiceChannel>}
* @example
* // set the bitrate of a voice channel
@@ -59,7 +59,7 @@ class VoiceChannel extends GuildChannel {
/**
* Leaves this voice channel
* @returns {null}
* @returns {void}
* @example
* // leave a voice channel
* voiceChannel.leave();