From 94e2a853861d6752606e3d9bac2d359657e309b0 Mon Sep 17 00:00:00 2001 From: Will Nelson Date: Fri, 21 Apr 2017 00:44:59 -0700 Subject: [PATCH] Docs fixes (#1398) * fix collector docs * fix message collector param type --- src/structures/MessageCollector.js | 4 ++-- src/structures/ReactionCollector.js | 2 +- src/structures/interfaces/Collector.js | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/src/structures/MessageCollector.js b/src/structures/MessageCollector.js index e932c128a..548b16615 100644 --- a/src/structures/MessageCollector.js +++ b/src/structures/MessageCollector.js @@ -8,12 +8,12 @@ const Collector = require('./interfaces/Collector'); /** * Collects messages on a channel. - * @implements {Collector} + * @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 {MessageCollectorOptions} options The options to be applied to this collector. * @emits MessageCollector#message diff --git a/src/structures/ReactionCollector.js b/src/structures/ReactionCollector.js index ae03f3b19..dcbc6de33 100644 --- a/src/structures/ReactionCollector.js +++ b/src/structures/ReactionCollector.js @@ -10,7 +10,7 @@ const Collection = require('../util/Collection'); /** * Collects reactions on messages. - * @implements {Collector} + * @extends {Collector} */ class ReactionCollector extends Collector { diff --git a/src/structures/interfaces/Collector.js b/src/structures/interfaces/Collector.js index d9d394ba1..14acfd715 100644 --- a/src/structures/interfaces/Collector.js +++ b/src/structures/interfaces/Collector.js @@ -15,8 +15,8 @@ const EventEmitter = require('events').EventEmitter; */ /** - * Interface for defining a new Collector. - * @interface + * Abstract class for defining a new Collector. + * @abstract */ class Collector extends EventEmitter { constructor(client, filter, options = {}) {