Fix manager docs (#2271)

discord-jda · Oct 6, 2022 · a128a89 · a128a89
1 parent 312f97a
commit a128a89
Show file tree

Hide file tree

Showing 15 changed files with 2 additions and 33 deletions.
diff --git a/src/main/java/net/dv8tion/jda/api/entities/Guild.java b/src/main/java/net/dv8tion/jda/api/entities/Guild.java
@@ -2009,9 +2009,6 @@ default RestAction<RichCustomEmoji> retrieveEmoji(@Nonnull CustomEmoji emoji)
      * all properties and settings of the Guild.
      * <br>You modify multiple fields in one request by chaining setters before calling {@link RestAction#queue() RestAction.queue()}.
      *
-     * <p>This is a lazy idempotent getter. The manager is retained after the first call.
-     * This getter is not thread-safe and would require guards by the user.
-     *
      * @throws net.dv8tion.jda.api.exceptions.InsufficientPermissionException
      *         If the currently logged in account does not have {@link net.dv8tion.jda.api.Permission#MANAGE_SERVER Permission.MANAGE_SERVER}
      *

diff --git a/src/main/java/net/dv8tion/jda/api/entities/PermissionOverride.java b/src/main/java/net/dv8tion/jda/api/entities/PermissionOverride.java
@@ -176,9 +176,6 @@ public interface PermissionOverride extends ISnowflake
      * <br>In the PermissionOverrideAction you can modify the permissions of the override.
      * You modify multiple fields in one request by chaining setters before calling {@link net.dv8tion.jda.api.requests.RestAction#queue() RestAction.queue()}.
      *
-     * <p>This is a lazy idempotent getter. The manager is retained after the first call.
-     * This getter is not thread-safe and would require guards by the user.
-     *
      * @throws net.dv8tion.jda.api.exceptions.InsufficientPermissionException
      *         If the currently logged in account does not have {@link net.dv8tion.jda.api.Permission#MANAGE_PERMISSIONS Permission.MANAGE_PERMISSIONS}
      *

diff --git a/src/main/java/net/dv8tion/jda/api/entities/Role.java b/src/main/java/net/dv8tion/jda/api/entities/Role.java
@@ -230,9 +230,6 @@ default RoleAction createCopy()
      * In the RoleManager, you can modify all its values.
      * <br>You modify multiple fields in one request by chaining setters before calling {@link net.dv8tion.jda.api.requests.RestAction#queue() RestAction.queue()}.
      *
-     * <p>This is a lazy idempotent getter. The manager is retained after the first call.
-     * This getter is not thread-safe and would require guards by the user.
-     *
      * @throws net.dv8tion.jda.api.exceptions.InsufficientPermissionException
      *         If the currently logged in account does not have {@link net.dv8tion.jda.api.Permission#MANAGE_ROLES Permission.MANAGE_ROLES}
      * @throws net.dv8tion.jda.api.exceptions.HierarchyException

diff --git a/src/main/java/net/dv8tion/jda/api/entities/SelfUser.java b/src/main/java/net/dv8tion/jda/api/entities/SelfUser.java
@@ -81,9 +81,6 @@ default String getApplicationId()
      * <br>This can be used to atomically set account fields (like avatar/username)
      * You modify multiple fields in one request by chaining setters before calling {@link net.dv8tion.jda.api.requests.RestAction#queue() RestAction.queue()}.
      *
-     * <p>This is a lazy idempotent getter. The manager is retained after the first call.
-     * This getter is not thread-safe and would require guards by the user.
-     *
      * @return An AccountManager instance for the current account
      */
     @Nonnull

diff --git a/src/main/java/net/dv8tion/jda/api/entities/Webhook.java b/src/main/java/net/dv8tion/jda/api/entities/Webhook.java
@@ -291,9 +291,6 @@ public interface Webhook extends ISnowflake
      * The {@link WebhookManager WebhookManager} for this Webhook.
      * <br>You can modify multiple fields in one request by chaining setters before calling {@link net.dv8tion.jda.api.requests.RestAction#queue() RestAction.queue()}.
      *
-     * <p>This is a lazy idempotent getter. The manager is retained after the first call.
-     * This getter is not thread-safe and would require guards by the user.
-     *
      * @throws net.dv8tion.jda.api.exceptions.InsufficientPermissionException
      *         If the currently logged in account does not have {@link net.dv8tion.jda.api.Permission#MANAGE_WEBHOOKS Permission.MANAGE_WEBHOOKS}
      *

diff --git a/src/main/java/net/dv8tion/jda/api/entities/channel/middleman/GuildChannel.java b/src/main/java/net/dv8tion/jda/api/entities/channel/middleman/GuildChannel.java
@@ -55,9 +55,6 @@ public interface GuildChannel extends Channel, Comparable<GuildChannel>
      * <br>In the ChannelManager, you can modify the name, topic and position of this GuildChannel.
      * You modify multiple fields in one request by chaining setters before calling {@link net.dv8tion.jda.api.requests.RestAction#queue() RestAction.queue()}.
      *
-     * <p>This is a lazy idempotent getter. The manager is retained after the first call.
-     * This getter is not thread-safe and would require guards by the user.
-     *
      * @throws net.dv8tion.jda.api.exceptions.InsufficientPermissionException
      *         If the currently logged in account does not have {@link net.dv8tion.jda.api.Permission#MANAGE_CHANNEL Permission.MANAGE_CHANNEL}
      *

diff --git a/src/main/java/net/dv8tion/jda/api/entities/emoji/RichCustomEmoji.java b/src/main/java/net/dv8tion/jda/api/entities/emoji/RichCustomEmoji.java
@@ -167,9 +167,6 @@ public interface RichCustomEmoji extends CustomEmoji
      * properties of the emoji like name and role restrictions.
      * <br>You modify multiple fields in one request by chaining setters before calling {@link net.dv8tion.jda.api.requests.RestAction#queue() RestAction.queue()}.
      *
-     * <p>This is a lazy idempotent getter. The manager is retained after the first call.
-     * This getter is not thread-safe and would require guards by the user.
-     *
      * @throws net.dv8tion.jda.api.exceptions.InsufficientPermissionException
      *         If the currently logged in account does not have {@link net.dv8tion.jda.api.Permission#MANAGE_EMOJIS_AND_STICKERS Permission.MANAGE_EMOJIS_AND_STICKERS}
      *

diff --git a/src/main/java/net/dv8tion/jda/api/entities/templates/Template.java b/src/main/java/net/dv8tion/jda/api/entities/templates/Template.java
@@ -261,9 +261,6 @@ public boolean isSynced()
      * <br>In the TemplateManager, you can modify the name or description of the template.
      * You modify multiple fields in one request by chaining setters before calling {@link net.dv8tion.jda.api.requests.RestAction#queue() RestAction.queue()}.
      *
-     * <p>This is a lazy idempotent getter. The manager is retained after the first call.
-     * This getter is not thread-safe and would require guards by the user.
-     *
      * @throws IllegalStateException
      *         If the account is not in the template's guild
      * @throws net.dv8tion.jda.api.exceptions.InsufficientPermissionException

diff --git a/src/main/java/net/dv8tion/jda/api/managers/AccountManager.java b/src/main/java/net/dv8tion/jda/api/managers/AccountManager.java
@@ -80,7 +80,6 @@ public interface AccountManager extends Manager<AccountManager>
 
     /**
      * Resets the fields specified by the provided bit-flag patterns.
-     * You can specify a combination by using a bitwise OR concat of the flag constants.
      * <br>Example: {@code manager.reset(AccountManager.NAME, AccountManager.AVATAR);}
      *
      * <p><b>Flag Constants:</b>

diff --git a/src/main/java/net/dv8tion/jda/api/managers/CustomEmojiManager.java b/src/main/java/net/dv8tion/jda/api/managers/CustomEmojiManager.java
@@ -69,8 +69,7 @@ public interface CustomEmojiManager extends Manager<CustomEmojiManager>
     CustomEmojiManager reset(long fields);
 
     /**
-     * Resets the fields specified by the provided bit-flag pattern.
-     * You can specify a combination by using a bitwise OR concat of the flag constants.
+     * Resets the fields specified by the provided bit-flag patterns.
      * <br>Example: {@code manager.reset(CustomEmojiManager.NAME, CustomEmojiManager.ROLES);}
      *
      * <p><b>Flag Constants:</b>

diff --git a/src/main/java/net/dv8tion/jda/api/managers/GuildManager.java b/src/main/java/net/dv8tion/jda/api/managers/GuildManager.java
@@ -107,7 +107,6 @@ public interface GuildManager extends Manager<GuildManager>
 
     /**
      * Resets the fields specified by the provided bit-flag patterns.
-     * You can specify a combination by using a bitwise OR concat of the flag constants.
      * <br>Example: {@code manager.reset(GuildManager.NAME, GuildManager.ICON);}
      *
      * <p><b>Flag Constants:</b>

diff --git a/src/main/java/net/dv8tion/jda/api/managers/GuildStickerManager.java b/src/main/java/net/dv8tion/jda/api/managers/GuildStickerManager.java
@@ -75,8 +75,7 @@ public interface GuildStickerManager extends Manager<GuildStickerManager>
     GuildStickerManager reset(long fields);
 
     /**
-     * Resets the fields specified by the provided bit-flag pattern.
-     * You can specify a combination by using a bitwise OR concat of the flag constants.
+     * Resets the fields specified by the provided bit-flag patterns.
      * <br>Example: {@code manager.reset(GuildStickerManager.NAME, GuildStickerManager.TAGS);}
      *
      * <p><b>Flag Constants:</b>

diff --git a/src/main/java/net/dv8tion/jda/api/managers/PermOverrideManager.java b/src/main/java/net/dv8tion/jda/api/managers/PermOverrideManager.java
@@ -76,7 +76,6 @@ public interface PermOverrideManager extends Manager<PermOverrideManager>
 
     /**
      * Resets the fields specified by the provided bit-flag patterns.
-     * You can specify a combination by using a bitwise OR concat of the flag constants.
      * <br>Example: {@code manager.reset(PermOverrideManager.ALLOWED, PermOverrideManager.DENIED);}
      *
      * <p><b>Flag Constants:</b>

diff --git a/src/main/java/net/dv8tion/jda/api/managers/RoleManager.java b/src/main/java/net/dv8tion/jda/api/managers/RoleManager.java
@@ -87,7 +87,6 @@ public interface RoleManager extends Manager<RoleManager>
 
     /**
      * Resets the fields specified by the provided bit-flag patterns.
-     * You can specify a combination by using a bitwise OR concat of the flag constants.
      * <br>Example: {@code manager.reset(RoleManager.COLOR, RoleManager.NAME);}
      *
      * <p><b>Flag Constants:</b>

diff --git a/src/main/java/net/dv8tion/jda/api/managers/WebhookManager.java b/src/main/java/net/dv8tion/jda/api/managers/WebhookManager.java
@@ -74,7 +74,6 @@ public interface WebhookManager extends Manager<WebhookManager>
 
     /**
      * Resets the fields specified by the provided bit-flag patterns.
-     * You can specify a combination by using a bitwise OR concat of the flag constants.
      * <br>Example: {@code manager.reset(WebhookManager.CHANNEL, WebhookManager.NAME);}
      *
      * <p><b>Flag Constants:</b>