docs: improve documentation (#1898)

* improve channel documentation

* forgot some stuff

* another one

* im good at this

* i did a dum
This commit is contained in:
Isabella
2017-09-07 19:01:35 -05:00
committed by Crawl
parent 41c4999c2b
commit 0607720ec8
7 changed files with 35 additions and 15 deletions

View File

@@ -23,7 +23,7 @@ class ChannelDeleteAction extends Action {
/**
* Emitted whenever a channel is deleted.
* @event Client#channelDelete
* @param {Channel} channel The channel that was deleted
* @param {GroupDMChannel|GuildChannel} channel The channel that was deleted
*/
module.exports = ChannelDeleteAction;

View File

@@ -6,10 +6,10 @@ class ChannelCreateHandler extends AbstractHandler {
}
}
module.exports = ChannelCreateHandler;
/**
* Emitted whenever a channel is created.
* @event Client#channelCreate
* @param {Channel} channel The channel that was created
* @param {DMChannel|GroupDMChannel|GuildChannel} channel The channel that was created
*/
module.exports = ChannelCreateHandler;

View File

@@ -20,12 +20,12 @@ class ChannelPinsUpdate extends AbstractHandler {
}
}
module.exports = ChannelPinsUpdate;
/**
* Emitted whenever the pins of a channel are updated. Due to the nature of the WebSocket event, not much information
* can be provided easily here - you need to manually check the pins yourself.
* @event Client#channelPinsUpdate
* @param {Channel} channel The channel that the pins update occured in
* @param {DMChannel|GroupDMChannel|TextChannel} channel The channel that the pins update occured in
* @param {Date} time The time of the pins update
*/
module.exports = ChannelPinsUpdate;

View File

@@ -15,6 +15,6 @@ module.exports = ChannelUpdateHandler;
/**
* Emitted whenever a channel is updated - e.g. name change, topic change.
* @event Client#channelUpdate
* @param {Channel} oldChannel The channel before the update
* @param {Channel} newChannel The channel after the update
* @param {DMChannel|GroupDMChannel|GuildChannel} oldChannel The channel before the update
* @param {DMChannel|GroupDMChannel|GuildChannel} newChannel The channel after the update
*/