Fix documentation

Fix missing module declarations, broken lings, broken formating and
incorrect scopes in the documentation.  For modules split over several
files it appears the only viable option is to use the memberof directive
on each documented member and only declare the index file as a module.
This commit is contained in:
Hornwitser committed 2020-05-08 17:28:06 +02:00
1 parent 7a9b6592e6
commit b151dd8469
22 files changed
+318 -56

No files matched your search

+33 -6
View File
@@ -3,10 +3,22 @@
* @module
*/
/**
* Thrown by commands when they fail
* @static
*/
class CommandError extends Error { }
/**
* Thrown from requests sent when an error occured handling it
* @static
*/
class RequestError extends Error { }
// Signal for messages that fail validation
/**
* Signal for messages that fail validation
* @static
*/
class InvalidMessage extends Error {
constructor(msg, errors) {
super(msg);
@@ -14,19 +26,34 @@ class InvalidMessage extends Error {
}
}
// Thrown from requests when the session it was sent on was lost.
/**
* Thrown from requests when the session it was sent on was lost
* @static
*/
class SessionLost extends Error { }
// Thrown when WebSocket authentication failed
/**
* Thrown when WebSocket authentication failed
* @static
*/
class AuthenticationFailed extends Error { }
// Errror class for known errors occuring during startup
/**
* Errror class for known errors occuring during startup
* @static
*/
class StartupError extends Error { }
// Errors outside of our control.
/**
* Errors outside of our control
* @static
*/
class EnvironmentError extends Error { }
// Errors caused by plugins
/**
* Errors caused by plugins
* @static
*/
class PluginError extends Error {
constructor(pluginName, original) {
super(`PluginError: ${original.message}`);