docs: Add missing @extends (#8205)

This commit is contained in:
Jiralite
2022-07-01 16:48:11 +01:00
committed by GitHub
parent 741b3c8e27
commit e0c8282490
10 changed files with 11 additions and 3 deletions

View File

@@ -36,7 +36,7 @@ const UNRESUMABLE_CLOSE_CODES = [1000, GatewayCloseCodes.AlreadyAuthenticated, G
* The WebSocket manager for this client. * The WebSocket manager for this client.
* <info>This class forwards raw dispatch events, * <info>This class forwards raw dispatch events,
* read more about it here {@link https://discord.com/developers/docs/topics/gateway}</info> * read more about it here {@link https://discord.com/developers/docs/topics/gateway}</info>
* @extends EventEmitter * @extends {EventEmitter}
*/ */
class WebSocketManager extends EventEmitter { class WebSocketManager extends EventEmitter {
constructor(client) { constructor(client) {

View File

@@ -20,6 +20,7 @@ try {
/** /**
* Represents a Shard's WebSocket connection * Represents a Shard's WebSocket connection
* @extends {EventEmitter}
*/ */
class WebSocketShard extends EventEmitter { class WebSocketShard extends EventEmitter {
constructor(manager, id) { constructor(manager, id) {

View File

@@ -14,7 +14,7 @@ let Worker = null;
* A self-contained shard created by the {@link ShardingManager}. Each one has a {@link ChildProcess} that contains * 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 * 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. * spawn a new one to replace it as necessary.
* @extends EventEmitter * @extends {EventEmitter}
*/ */
class Shard extends EventEmitter { class Shard extends EventEmitter {
constructor(manager, id) { constructor(manager, id) {

View File

@@ -20,7 +20,8 @@ const IntegrationApplication = require('./IntegrationApplication');
*/ */
/** /**
* Represents a guild integration. * Represents a guild integration.
* @extends {Base}
*/ */
class Integration extends Base { class Integration extends Base {
constructor(client, data, guild) { constructor(client, data, guild) {

View File

@@ -23,6 +23,7 @@ const getMessage = lazy(() => require('./Message').Message);
/** /**
* Represents a modal interaction * Represents a modal interaction
* @extends {BaseInteraction}
* @implements {InteractionResponses} * @implements {InteractionResponses}
*/ */
class ModalSubmitInteraction extends BaseInteraction { class ModalSubmitInteraction extends BaseInteraction {

View File

@@ -6,6 +6,7 @@ const { Error, TypeError, ErrorCodes } = require('../errors');
/** /**
* Represents the voice state for a Guild Member. * Represents the voice state for a Guild Member.
* @extends {Base}
*/ */
class VoiceState extends Base { class VoiceState extends Base {
constructor(guild, data) { constructor(guild, data) {

View File

@@ -7,6 +7,7 @@ const WidgetMember = require('./WidgetMember');
/** /**
* Represents a Widget. * Represents a Widget.
* @extends {Base}
*/ */
class Widget extends Base { class Widget extends Base {
constructor(client, data) { constructor(client, data) {

View File

@@ -4,6 +4,7 @@ const Base = require('./Base');
/** /**
* Represents a WidgetMember. * Represents a WidgetMember.
* @extends {Base}
*/ */
class WidgetMember extends Base { class WidgetMember extends Base {
/** /**

View File

@@ -5,6 +5,7 @@ const Base = require('../Base');
/** /**
* Represents an OAuth2 Application. * Represents an OAuth2 Application.
* @extends {Base}
* @abstract * @abstract
*/ */
class Application extends Base { class Application extends Base {

View File

@@ -25,6 +25,7 @@ const { flatten } = require('../../util/Util');
/** /**
* Abstract class for defining a new Collector. * Abstract class for defining a new Collector.
* @extends {EventEmitter}
* @abstract * @abstract
*/ */
class Collector extends EventEmitter { class Collector extends EventEmitter {