Improve docs a bit

This commit is contained in:
Crawl
2017-04-30 04:30:44 +02:00
parent 3f8c0a4d11
commit ac92d2cecc
83 changed files with 716 additions and 711 deletions

View File

@@ -24,7 +24,7 @@ class GuildMembersChunkHandler extends AbstractHandler {
}
/**
* Emitted whenever a chunk of guild members is received (all members come from the same guild)
* Emitted whenever a chunk of guild members is received (all members come from the same guild).
* @event Client#guildMembersChunk
* @param {Collection<Snowflake, GuildMember>} members The members in the chunk
* @param {Guild} guild The guild related to the member chunk

View File

@@ -11,7 +11,7 @@ class MessageCreateHandler extends AbstractHandler {
}
/**
* Emitted whenever a message is created
* Emitted whenever a message is created.
* @event Client#message
* @param {Message} message The created message
*/

View File

@@ -11,7 +11,7 @@ class MessageDeleteHandler extends AbstractHandler {
}
/**
* Emitted whenever a message is deleted
* Emitted whenever a message is deleted.
* @event Client#messageDelete
* @param {Message} message The deleted message
*/

View File

@@ -9,7 +9,7 @@ class MessageDeleteBulkHandler extends AbstractHandler {
}
/**
* Emitted whenever messages are deleted in bulk
* Emitted whenever messages are deleted in bulk.
* @event Client#messageDeleteBulk
* @param {Collection<Snowflake, Message>} messages The deleted messages, mapped by their ID
*/

View File

@@ -68,7 +68,7 @@ class PresenceUpdateHandler extends AbstractHandler {
*/
/**
* Emitted whenever a member becomes available in a large guild
* Emitted whenever a member becomes available in a large guild.
* @event Client#guildMemberAvailable
* @param {GuildMember} member The member that became available
*/

View File

@@ -20,9 +20,9 @@ class ResumedHandler extends AbstractHandler {
}
/**
* Emitted whenever a websocket resumes
* Emitted whenever a WebSocket resumes.
* @event Client#resume
* @param {number} replayed Number of events that were replayed
* @param {number} replayed The number of events that were replayed
*/
module.exports = ResumedHandler;

View File

@@ -52,14 +52,14 @@ function tooLate(channel, user) {
}
/**
* Emitted whenever a user starts typing in a channel
* Emitted whenever a user starts typing in a channel.
* @event Client#typingStart
* @param {Channel} channel The channel the user started typing in
* @param {User} user The user that started typing
*/
/**
* Emitted whenever a user stops typing in a channel
* Emitted whenever a user stops typing in a channel.
* @event Client#typingStop
* @param {Channel} channel The channel the user stopped typing in
* @param {User} user The user that stopped typing

View File

@@ -10,7 +10,7 @@ class UserSettingsUpdateHandler extends AbstractHandler {
}
/**
* Emitted when the client user's settings update
* Emitted when the client user's settings update.
* @event Client#clientUserSettingsUpdate
* @param {ClientUserSettings} clientUserSettings The new client user settings
*/