From 1779e1ba7e9bf7aad9a853097a841a36416d8ce6 Mon Sep 17 00:00:00 2001 From: Jiralite <33201955+Jiralite@users.noreply.github.com> Date: Tue, 10 Jan 2023 09:51:10 +0000 Subject: [PATCH] docs: Add missing `@extends` (#9028) --- src/client/websocket/WebSocketManager.js | 2 +- src/client/websocket/WebSocketShard.js | 1 + src/sharding/Shard.js | 2 +- src/structures/DirectoryChannel.js | 3 ++- src/structures/Integration.js | 3 ++- src/structures/VoiceState.js | 1 + src/structures/Widget.js | 1 + src/structures/WidgetMember.js | 1 + src/structures/interfaces/Application.js | 1 + src/structures/interfaces/Collector.js | 1 + 10 files changed, 12 insertions(+), 4 deletions(-) diff --git a/src/client/websocket/WebSocketManager.js b/src/client/websocket/WebSocketManager.js index 8838489cc..e6bef4fa9 100644 --- a/src/client/websocket/WebSocketManager.js +++ b/src/client/websocket/WebSocketManager.js @@ -31,7 +31,7 @@ const UNRESUMABLE_CLOSE_CODES = [ * The WebSocket manager for this client. * This class forwards raw dispatch events, * read more about it here {@link https://discord.com/developers/docs/topics/gateway} - * @extends EventEmitter + * @extends {EventEmitter} */ class WebSocketManager extends EventEmitter { constructor(client) { diff --git a/src/client/websocket/WebSocketShard.js b/src/client/websocket/WebSocketShard.js index 0c59f8019..a5407bcc2 100644 --- a/src/client/websocket/WebSocketShard.js +++ b/src/client/websocket/WebSocketShard.js @@ -17,6 +17,7 @@ try { /** * Represents a Shard's WebSocket connection + * @extends {EventEmitter} */ class WebSocketShard extends EventEmitter { constructor(manager, id) { diff --git a/src/sharding/Shard.js b/src/sharding/Shard.js index 321c07973..fad090949 100644 --- a/src/sharding/Shard.js +++ b/src/sharding/Shard.js @@ -14,7 +14,7 @@ let Worker = null; * A self-contained shard created by the {@link ShardingManager}. Each one has a {@link ChildProcess} that contains * an instance of the bot and its {@link Client}. When its child process/worker exits for any reason, the shard will * spawn a new one to replace it as necessary. - * @extends EventEmitter + * @extends {EventEmitter} */ class Shard extends EventEmitter { constructor(manager, id) { diff --git a/src/structures/DirectoryChannel.js b/src/structures/DirectoryChannel.js index faf2e3d04..ba13f85e0 100644 --- a/src/structures/DirectoryChannel.js +++ b/src/structures/DirectoryChannel.js @@ -3,7 +3,8 @@ const { Channel } = require('./Channel'); /** - * Represents a channel that displays a directory of guilds + * Represents a channel that displays a directory of guilds. + * @extends {Channel} */ class DirectoryChannel extends Channel { _patch(data) { diff --git a/src/structures/Integration.js b/src/structures/Integration.js index 5773de861..a2f9d7e44 100644 --- a/src/structures/Integration.js +++ b/src/structures/Integration.js @@ -19,7 +19,8 @@ const IntegrationApplication = require('./IntegrationApplication'); */ /** - * Represents a guild integration. + * Represents a guild integration. + * @extends {Base} */ class Integration extends Base { constructor(client, data, guild) { diff --git a/src/structures/VoiceState.js b/src/structures/VoiceState.js index 18ab16f90..1a7fc6477 100644 --- a/src/structures/VoiceState.js +++ b/src/structures/VoiceState.js @@ -5,6 +5,7 @@ const { Error, TypeError } = require('../errors'); /** * Represents the voice state for a Guild Member. + * @extends {Base} */ class VoiceState extends Base { constructor(guild, data) { diff --git a/src/structures/Widget.js b/src/structures/Widget.js index 7373d0a4d..6ee0cae8d 100644 --- a/src/structures/Widget.js +++ b/src/structures/Widget.js @@ -6,6 +6,7 @@ const WidgetMember = require('./WidgetMember'); /** * Represents a Widget. + * @extends {Base} */ class Widget extends Base { constructor(client, data) { diff --git a/src/structures/WidgetMember.js b/src/structures/WidgetMember.js index 472d9e2dc..d7aca2172 100644 --- a/src/structures/WidgetMember.js +++ b/src/structures/WidgetMember.js @@ -4,6 +4,7 @@ const Base = require('./Base'); /** * Represents a WidgetMember. + * @extends {Base} */ class WidgetMember extends Base { /** diff --git a/src/structures/interfaces/Application.js b/src/structures/interfaces/Application.js index 2334bdaa6..fcac84d81 100644 --- a/src/structures/interfaces/Application.js +++ b/src/structures/interfaces/Application.js @@ -11,6 +11,7 @@ let deprecationEmittedForFetchAssets = false; /** * Represents an OAuth2 Application. + * @extends {Base} * @abstract */ class Application extends Base { diff --git a/src/structures/interfaces/Collector.js b/src/structures/interfaces/Collector.js index c0793fd03..a923f04c7 100644 --- a/src/structures/interfaces/Collector.js +++ b/src/structures/interfaces/Collector.js @@ -25,6 +25,7 @@ const Util = require('../../util/Util'); /** * Abstract class for defining a new Collector. + * @extends {EventEmitter} * @abstract */ class Collector extends EventEmitter {