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

@@ -21,7 +21,7 @@ class VoiceReceiver extends EventEmitter {
super();
/*
Need a queue because we don't get the ssrc of the user speaking until after the first few packets,
so we queue up unknown SSRCs until they become known, then empty the queue.
so we queue up unknown SSRCs until they become known, then empty the queue
*/
this.queues = new Map();
this.pcmStreams = new Map();
@@ -29,7 +29,7 @@ class VoiceReceiver extends EventEmitter {
this.opusEncoders = new Map();
/**
* Whether or not this receiver has been destroyed.
* Whether or not this receiver has been destroyed
* @type {boolean}
*/
this.destroyed = false;
@@ -91,7 +91,7 @@ class VoiceReceiver extends EventEmitter {
}
/**
* Invoked when a user stops speaking
* Invoked when a user stops speaking.
* @param {User} user The user that stopped speaking
* @private
*/
@@ -153,7 +153,7 @@ class VoiceReceiver extends EventEmitter {
* @event VoiceReceiver#warn
* @param {string} reason The reason for the warning. If it happened because the voice packet could not be
* decrypted, this would be `decrypt`. If it happened because the voice packet could not be decoded into
* PCM, this would be `decode`.
* PCM, this would be `decode`
* @param {string} message The warning message
*/
this.emit('warn', 'decrypt', 'Failed to decrypt voice packet');