Docs fixes (#1398)

* fix collector docs

* fix message collector param type
This commit is contained in:
Will Nelson
2017-04-21 00:44:59 -07:00
committed by Crawl
parent a652901d60
commit 94e2a85386
3 changed files with 5 additions and 5 deletions

View File

@@ -8,12 +8,12 @@ const Collector = require('./interfaces/Collector');
/** /**
* Collects messages on a channel. * Collects messages on a channel.
* @implements {Collector} * @extends {Collector}
*/ */
class MessageCollector extends Collector { class MessageCollector extends Collector {
/** /**
* @param {TextBasedChannel} channel The channel. * @param {TextChannel|DMChannel|GroupDMChannel} channel The channel.
* @param {CollectorFilter} filter The filter to be applied to this collector. * @param {CollectorFilter} filter The filter to be applied to this collector.
* @param {MessageCollectorOptions} options The options to be applied to this collector. * @param {MessageCollectorOptions} options The options to be applied to this collector.
* @emits MessageCollector#message * @emits MessageCollector#message

View File

@@ -10,7 +10,7 @@ const Collection = require('../util/Collection');
/** /**
* Collects reactions on messages. * Collects reactions on messages.
* @implements {Collector} * @extends {Collector}
*/ */
class ReactionCollector extends Collector { class ReactionCollector extends Collector {

View File

@@ -15,8 +15,8 @@ const EventEmitter = require('events').EventEmitter;
*/ */
/** /**
* Interface for defining a new Collector. * Abstract class for defining a new Collector.
* @interface * @abstract
*/ */
class Collector extends EventEmitter { class Collector extends EventEmitter {
constructor(client, filter, options = {}) { constructor(client, filter, options = {}) {