ci: api-extractor support for docs

packages/voice/src/networking/VoiceUDPSocket.ts

@@ -125,7 +125,7 @@ export class VoiceUDPSocket extends EventEmitter {
 	/**
 	 * Called when a message is received on the UDP socket.
 	 *
-	 * @param buffer The received buffer
+	 * @param buffer - The received buffer
 	 */
 	private onMessage(buffer: Buffer): void {
 		// Handle keep alive message

packages/voice/src/receive/SSRCMap.ts

@@ -45,7 +45,7 @@ export class SSRCMap extends EventEmitter {
 	/**
 	 * Updates the map with new user data
 	 *
-	 * @param data The data to update with
+	 * @param data - The data to update with
 	 */
 	public update(data: VoiceUserData) {
 		const existing = this.map.get(data.audioSSRC);
@@ -63,7 +63,7 @@ export class SSRCMap extends EventEmitter {
 	/**
 	 * Gets the stored voice data of a user.
 	 *
-	 * @param target The target, either their user id or audio SSRC
+	 * @param target - The target, either their user id or audio SSRC
 	 */
 	public get(target: number | string) {
 		if (typeof target === 'number') {
@@ -82,7 +82,7 @@ export class SSRCMap extends EventEmitter {
 	/**
 	 * Deletes the stored voice data about a user.
 	 *
-	 * @param target The target of the delete operation, either their audio SSRC or user id
+	 * @param target - The target of the delete operation, either their audio SSRC or user id
 	 *
 	 * @returns The data that was deleted, if any
 	 */

packages/voice/src/receive/VoiceReceiver.ts

@@ -58,7 +58,7 @@ export class VoiceReceiver {
 	/**
 	 * Called when a packet is received on the attached connection's WebSocket.
 	 *
-	 * @param packet The received packet
+	 * @param packet - The received packet
 	 *
 	 * @internal
 	 */
@@ -118,10 +118,10 @@ export class VoiceReceiver {
 	/**
 	 * Parses an audio packet, decrypting it to yield an Opus packet.
 	 *
-	 * @param buffer The buffer to parse
-	 * @param mode The encryption mode
-	 * @param nonce The nonce buffer used by the connection for encryption
-	 * @param secretKey The secret key used by the connection for encryption
+	 * @param buffer - The buffer to parse
+	 * @param mode - The encryption mode
+	 * @param nonce - The nonce buffer used by the connection for encryption
+	 * @param secretKey - The secret key used by the connection for encryption
 	 *
 	 * @returns The parsed Opus packet
 	 */
@@ -152,7 +152,7 @@ export class VoiceReceiver {
 	/**
 	 * Called when the UDP socket of the attached connection receives a message.
 	 *
-	 * @param msg The received message
+	 * @param msg - The received message
 	 *
 	 * @internal
 	 */
@@ -186,7 +186,7 @@ export class VoiceReceiver {
 	/**
 	 * Creates a subscription for the given user id.
 	 *
-	 * @param target The id of the user to subscribe to
+	 * @param target - The id of the user to subscribe to
 	 *
 	 * @returns A readable stream of Opus packets received from the target
 	 */

packages/voice/src/util/demuxProbe.ts

@@ -6,7 +6,7 @@ import { StreamType } from '..';
 /**
  * Takes an Opus Head, and verifies whether the associated Opus audio is suitable to play in a Discord voice channel.
  *
- * @param opusHead The Opus Head to validate
+ * @param opusHead - The Opus Head to validate
  *
  * @returns `true` if suitable to play in a Discord voice channel, otherwise `false`
  */
@@ -35,9 +35,9 @@ export interface ProbeInfo {
 /**
  * Attempt to probe a readable stream to figure out whether it can be demuxed using an Ogg or WebM Opus demuxer.
  *
- * @param stream The readable stream to probe
- * @param probeSize The number of bytes to attempt to read before giving up on the probe
- * @param validator The Opus Head validator function
+ * @param stream - The readable stream to probe
+ * @param probeSize - The number of bytes to attempt to read before giving up on the probe
+ * @param validator - The Opus Head validator function
  *
  * @experimental
  */