docs: Correctly overwrite setRTCRegion method (#8642)

docs: correctly overwrite `setRTCRegion` method Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
discordjs · Sep 19, 2022 · f049734 · f049734
1 parent f6f15d8
commit f049734
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 28 deletions.
diff --git a/packages/discord.js/src/structures/StageChannel.js b/packages/discord.js/src/structures/StageChannel.js
@@ -51,20 +51,22 @@ class StageChannel extends BaseGuildVoiceChannel {
   setTopic(topic, reason) {
     return this.edit({ topic, reason });
   }
-
-  /**
-   * Sets the RTC region of the channel.
-   * @name StageChannel#setRTCRegion
-   * @param {?string} rtcRegion The new region of the channel. Set to `null` to remove a specific region for the channel
-   * @param {string} [reason] The reason for modifying this region.
-   * @returns {Promise<StageChannel>}
-   * @example
-   * // Set the RTC region to sydney
-   * stageChannel.setRTCRegion('sydney');
-   * @example
-   * // Remove a fixed region for this channel - let Discord decide automatically
-   * stageChannel.setRTCRegion(null, 'We want to let Discord decide.');
-   */
 }
 
+/**
+ * Sets the RTC region of the channel.
+ * @method setRTCRegion
+ * @memberof StageChannel
+ * @instance
+ * @param {?string} rtcRegion The new region of the channel. Set to `null` to remove a specific region for the channel
+ * @param {string} [reason] The reason for modifying this region.
+ * @returns {Promise<StageChannel>}
+ * @example
+ * // Set the RTC region to sydney
+ * stageChannel.setRTCRegion('sydney');
+ * @example
+ * // Remove a fixed region for this channel - let Discord decide automatically
+ * stageChannel.setRTCRegion(null, 'We want to let Discord decide.');
+ */
+
 module.exports = StageChannel;
diff --git a/packages/discord.js/src/structures/VoiceChannel.js b/packages/discord.js/src/structures/VoiceChannel.js
@@ -149,22 +149,24 @@ class VoiceChannel extends BaseGuildVoiceChannel {
   createWebhook() {}
   setRateLimitPerUser() {}
   setNSFW() {}
-
-  /**
-   * Sets the RTC region of the channel.
-   * @name VoiceChannel#setRTCRegion
-   * @param {?string} rtcRegion The new region of the channel. Set to `null` to remove a specific region for the channel
-   * @param {string} [reason] The reason for modifying this region.
-   * @returns {Promise<VoiceChannel>}
-   * @example
-   * // Set the RTC region to sydney
-   * voiceChannel.setRTCRegion('sydney');
-   * @example
-   * // Remove a fixed region for this channel - let Discord decide automatically
-   * voiceChannel.setRTCRegion(null, 'We want to let Discord decide.');
-   */
 }
 
 TextBasedChannel.applyToClass(VoiceChannel, true, ['lastPinAt']);
 
+/**
+ * Sets the RTC region of the channel.
+ * @method setRTCRegion
+ * @memberof VoiceChannel
+ * @instance
+ * @param {?string} rtcRegion The new region of the channel. Set to `null` to remove a specific region for the channel
+ * @param {string} [reason] The reason for modifying this region.
+ * @returns {Promise<VoiceChannel>}
+ * @example
+ * // Set the RTC region to sydney
+ * voiceChannel.setRTCRegion('sydney');
+ * @example
+ * // Remove a fixed region for this channel - let Discord decide automatically
+ * voiceChannel.setRTCRegion(null, 'We want to let Discord decide.');
+ */
+
 module.exports = VoiceChannel;