More docs cleanup

This commit is contained in:
Crawl
2017-08-20 22:15:51 +02:00
parent c7d1507e19
commit 2478092d44
7 changed files with 16 additions and 14 deletions

View File

@@ -165,7 +165,7 @@ class VoiceConnection extends EventEmitter {
}
/**
* Set the token and endpoint required to connect to the the voice servers.
* Set the token and endpoint required to connect to the voice servers.
* @param {string} token The voice token
* @param {string} endpoint The voice endpoint
* @returns {void}

View File

@@ -47,8 +47,8 @@ class GroupDMChannel extends Channel {
this.name = data.name;
/**
* A hash of the Group DM icon.
* @type {string}
* A hash of this Group DM icon
* @type {?string}
*/
this.icon = data.icon;
@@ -70,11 +70,13 @@ class GroupDMChannel extends Channel {
*/
this.applicationID = data.application_id;
/**
* Nicknames for group members
* @type {?Collection<Snowflake, string>}
*/
if (data.nicks) this.nicks = new Collection(data.nicks.map(n => [n.id, n.nick]));
if (data.nicks) {
/**
* Nicknames for group members
* @type {?Collection<Snowflake, string>}
*/
this.nicks = new Collection(data.nicks.map(n => [n.id, n.nick]));
}
if (!this.recipients) {
/**

View File

@@ -18,7 +18,7 @@ const Snowflake = require('../util/Snowflake');
class Guild {
constructor(client, data) {
/**
* The client that created the instance of the the guild
* The client that created the instance of the guild
* @name Guild#client
* @type {Client}
* @readonly

View File

@@ -102,7 +102,7 @@ class MessageMentions {
/**
* Any channels that were mentioned
* @type {?Collection<Snowflake, GuildChannel>}
* @type {Collection<Snowflake, GuildChannel>}
* @readonly
*/
get channels() {

View File

@@ -10,7 +10,7 @@ const Snowflake = require('../util/Snowflake');
class User {
constructor(client, data) {
/**
* The client that created the instance of the the user
* The client that created the instance of the user
* @name User#client
* @type {}
* @readonly

View File

@@ -36,7 +36,7 @@ class Webhook {
/**
* The avatar for the webhook
* @type {string}
* @type {?string}
*/
this.avatar = data.avatar;

View File

@@ -555,8 +555,8 @@ exports.UserSettingsMap = {
explicit_content_filter: function explicitContentFilter(type) { // eslint-disable-line func-name-matching
/**
* Safe direct messaging; force people's messages with images to be scanned before they are sent to you
* one of `DISABLED`, `NON_FRIENDS`, `FRIENDS_AND_NON_FRIENDS`
* Safe direct messaging; force people's messages with images to be scanned before they are sent to you.
* One of `DISABLED`, `NON_FRIENDS`, `FRIENDS_AND_NON_FRIENDS`
* @name ClientUserSettings#explicitContentFilter
* @type {string}
*/