From f7b7aac8b6fdd0ff66801ebc4de7773db4737523 Mon Sep 17 00:00:00 2001
From: Jiralite <33201955+Jiralite@users.noreply.github.com>
Date: Sat, 16 Oct 2021 23:17:33 +0100
Subject: [PATCH] docs: Correct tags used for objects (#6846)
---
.../ApplicationCommandPermissionsManager.js | 16 ++++++++--------
src/managers/GuildStickerManager.js | 4 ++--
src/structures/GuildChannel.js | 4 ++--
src/structures/interfaces/TextBasedChannel.js | 4 ++--
4 files changed, 14 insertions(+), 14 deletions(-)
diff --git a/src/managers/ApplicationCommandPermissionsManager.js b/src/managers/ApplicationCommandPermissionsManager.js
index b014131a0..a93a8f276 100644
--- a/src/managers/ApplicationCommandPermissionsManager.js
+++ b/src/managers/ApplicationCommandPermissionsManager.js
@@ -71,9 +71,9 @@ class ApplicationCommandPermissionsManager extends BaseManager {
* When passing these options to a manager where `guildId` is `null`,
* `guild` is a required parameter
* @typedef {Object} BaseApplicationCommandPermissionsOptions
- * @param {GuildResolvable} [guild] The guild to modify / check permissions for
+ * @property {GuildResolvable} [guild] The guild to modify / check permissions for
* Ignored when the manager has a non-null `guildId` property
- * @param {ApplicationCommandResolvable} [command] The command to modify / check permissions for
+ * @property {ApplicationCommandResolvable} [command] The command to modify / check permissions for
* Ignored when the manager has a non-null `commandId` property
*/
@@ -122,8 +122,8 @@ class ApplicationCommandPermissionsManager extends BaseManager {
* One of `command` AND `permissions`, OR `fullPermissions` is required.
* `fullPermissions` is not a valid option when passing to a manager where `commandId` is non-null
* @typedef {BaseApplicationCommandPermissionsOptions} SetApplicationCommandPermissionsOptions
- * @param {ApplicationCommandPermissionData[]} [permissions] The new permissions for the command
- * @param {GuildApplicationCommandPermissionData[]} [fullPermissions] The new permissions for all commands
+ * @property {ApplicationCommandPermissionData[]} [permissions] The new permissions for the command
+ * @property {GuildApplicationCommandPermissionData[]} [fullPermissions] The new permissions for all commands
* in a guild When this parameter is set, `permissions` and `command` are ignored
*/
@@ -200,7 +200,7 @@ class ApplicationCommandPermissionsManager extends BaseManager {
* Options used to add permissions to a command
* The `command` parameter is not optional when the managers `commandId` is `null`
* @typedef {BaseApplicationCommandPermissionsOptions} AddApplicationCommandPermissionsOptions
- * @param {ApplicationCommandPermissionData[]} permissions The permissions to add to the command
+ * @property {ApplicationCommandPermissionData[]} permissions The permissions to add to the command
*/
/**
@@ -247,9 +247,9 @@ class ApplicationCommandPermissionsManager extends BaseManager {
* Options used to remove permissions from a command
* The `command` parameter is not optional when the managers `commandId` is `null`
* @typedef {BaseApplicationCommandPermissionsOptions} RemoveApplicationCommandPermissionsOptions
- * @param {UserResolvable|UserResolvable[]} [users] The user(s) to remove from the command permissions
+ * @property {UserResolvable|UserResolvable[]} [users] The user(s) to remove from the command permissions
* One of `users` or `roles` is required
- * @param {RoleResolvable|RoleResolvable[]} [roles] The role(s) to remove from the command permissions
+ * @property {RoleResolvable|RoleResolvable[]} [roles] The role(s) to remove from the command permissions
* One of `users` or `roles` is required
*/
@@ -331,7 +331,7 @@ class ApplicationCommandPermissionsManager extends BaseManager {
* Options used to check the existence of permissions on a command
* The `command` parameter is not optional when the managers `commandId` is `null`
* @typedef {BaseApplicationCommandPermissionsOptions} HasApplicationCommandPermissionsOptions
- * @param {UserResolvable|RoleResolvable} permissionId The user or role to check if a permission exists for
+ * @property {UserResolvable|RoleResolvable} permissionId The user or role to check if a permission exists for
* on this command.
*/
diff --git a/src/managers/GuildStickerManager.js b/src/managers/GuildStickerManager.js
index 99192e227..3ea95a8c1 100644
--- a/src/managers/GuildStickerManager.js
+++ b/src/managers/GuildStickerManager.js
@@ -34,8 +34,8 @@ class GuildStickerManager extends CachedManager {
/**
* Options for creating a guild sticker.
* @typedef {Object} GuildStickerCreateOptions
- * @param {?string} [description] The description for the sticker
- * @param {string} [reason] Reason for creating the sticker
+ * @property {?string} [description] The description for the sticker
+ * @property {string} [reason] Reason for creating the sticker
*/
/**
diff --git a/src/structures/GuildChannel.js b/src/structures/GuildChannel.js
index 7ff6ce182..fb35e4d72 100644
--- a/src/structures/GuildChannel.js
+++ b/src/structures/GuildChannel.js
@@ -393,8 +393,8 @@ class GuildChannel extends Channel {
/**
* Options used to set the position of a channel.
* @typedef {Object} SetChannelPositionOptions
- * @param {boolean} [relative=false] Whether or not to change the position relative to its current value
- * @param {string} [reason] The reason for changing the position
+ * @property {boolean} [relative=false] Whether or not to change the position relative to its current value
+ * @property {string} [reason] The reason for changing the position
*/
/**
diff --git a/src/structures/interfaces/TextBasedChannel.js b/src/structures/interfaces/TextBasedChannel.js
index 4b37e533d..83a0e26a0 100644
--- a/src/structures/interfaces/TextBasedChannel.js
+++ b/src/structures/interfaces/TextBasedChannel.js
@@ -101,8 +101,8 @@ class TextBasedChannel {
/**
* Options for sending a message with a reply.
* @typedef {Object} ReplyOptions
- * @param {MessageResolvable} messageReference The message to reply to (must be in the same channel and not system)
- * @param {boolean} [failIfNotExists=true] Whether to error if the referenced message
+ * @property {MessageResolvable} messageReference The message to reply to (must be in the same channel and not system)
+ * @property {boolean} [failIfNotExists=true] Whether to error if the referenced message
* does not exist (creates a standard message in this case when false)
*/