Make JSDocs follow general conventions (#582)

* Make JSDocs follow usual conventions

* Fix StringResolvable name

* Make function lowercase
This commit is contained in:
Schuyler Cebulskie
2016-09-03 04:57:25 -04:00
committed by Amish Shah
parent 44efcf3f52
commit 27652b94af
33 changed files with 262 additions and 262 deletions

View File

@@ -26,7 +26,7 @@ class StreamDispatcher extends EventEmitter {
/**
* Emitted when the dispatcher starts/stops speaking
* @event StreamDispatcher#speaking
* @param {Boolean} value whether or not the dispatcher is speaking
* @param {boolean} value whether or not the dispatcher is speaking
*/
_setSpeaking(value) {
this.speaking = value;
@@ -129,7 +129,7 @@ class StreamDispatcher extends EventEmitter {
/**
* Emitted when the stream wants to give debug information.
* @event StreamDispatcher#debug
* @param {String} information the debug information
* @param {string} information the debug information
*/
this.emit('debug', `triggered terminal state ${state} - stream is now dead`);
this._triggered = true;
@@ -172,7 +172,7 @@ class StreamDispatcher extends EventEmitter {
/**
* Stops the current stream permanently and emits an `end` event.
* @returns {null}
* @returns {void}
*/
end() {
this._triggerTerminalState('end', 'user requested');
@@ -180,7 +180,7 @@ class StreamDispatcher extends EventEmitter {
/**
* Stops sending voice packets to the voice connection (stream may still progress however)
* @returns {null}
* @returns {void}
*/
pause() {
this._pause(true);
@@ -188,7 +188,7 @@ class StreamDispatcher extends EventEmitter {
/**
* Resumes sending voice packets to the voice connection (may be further on in the stream than when paused)
* @returns {null}
* @returns {void}
*/
resume() {
this._pause(false);