Skip to content

Commit

Permalink
docs: Add missing @extends (#9028)
Browse files Browse the repository at this point in the history
  • Loading branch information
Jiralite committed Jan 10, 2023
1 parent 11d010f commit 1779e1b
Show file tree
Hide file tree
Showing 10 changed files with 12 additions and 4 deletions.
2 changes: 1 addition & 1 deletion src/client/websocket/WebSocketManager.js
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ const UNRESUMABLE_CLOSE_CODES = [
* The WebSocket manager for this client.
* <info>This class forwards raw dispatch events,
* read more about it here {@link https://discord.com/developers/docs/topics/gateway}</info>
* @extends EventEmitter
* @extends {EventEmitter}
*/
class WebSocketManager extends EventEmitter {
constructor(client) {
Expand Down
1 change: 1 addition & 0 deletions src/client/websocket/WebSocketShard.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ try {

/**
* Represents a Shard's WebSocket connection
* @extends {EventEmitter}
*/
class WebSocketShard extends EventEmitter {
constructor(manager, id) {
Expand Down
2 changes: 1 addition & 1 deletion src/sharding/Shard.js
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down
3 changes: 2 additions & 1 deletion src/structures/DirectoryChannel.js
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down
3 changes: 2 additions & 1 deletion src/structures/Integration.js
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down
1 change: 1 addition & 0 deletions src/structures/VoiceState.js
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down
1 change: 1 addition & 0 deletions src/structures/Widget.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ const WidgetMember = require('./WidgetMember');

/**
* Represents a Widget.
* @extends {Base}
*/
class Widget extends Base {
constructor(client, data) {
Expand Down
1 change: 1 addition & 0 deletions src/structures/WidgetMember.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ const Base = require('./Base');

/**
* Represents a WidgetMember.
* @extends {Base}
*/
class WidgetMember extends Base {
/**
Expand Down
1 change: 1 addition & 0 deletions src/structures/interfaces/Application.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ let deprecationEmittedForFetchAssets = false;

/**
* Represents an OAuth2 Application.
* @extends {Base}
* @abstract
*/
class Application extends Base {
Expand Down
1 change: 1 addition & 0 deletions src/structures/interfaces/Collector.js
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ const Util = require('../../util/Util');

/**
* Abstract class for defining a new Collector.
* @extends {EventEmitter}
* @abstract
*/
class Collector extends EventEmitter {
Expand Down

0 comments on commit 1779e1b

Please sign in to comment.