From ba22201311e7b9ba04c819a314ba452b43f25c94 Mon Sep 17 00:00:00 2001 From: Andre_601 <11576465+Andre601@users.noreply.github.com> Date: Mon, 14 Dec 2020 01:02:01 +0100 Subject: [PATCH 1/5] Fix Javadoc build errors --- .../clip/placeholderapi/expansion/PlaceholderExpansion.java | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/main/java/me/clip/placeholderapi/expansion/PlaceholderExpansion.java b/src/main/java/me/clip/placeholderapi/expansion/PlaceholderExpansion.java index 385ce4a..fb3d24a 100644 --- a/src/main/java/me/clip/placeholderapi/expansion/PlaceholderExpansion.java +++ b/src/main/java/me/clip/placeholderapi/expansion/PlaceholderExpansion.java @@ -231,6 +231,8 @@ public abstract class PlaceholderExpansion extends PlaceholderHook { /** * @deprecated As of versions greater than 2.8.7, use {@link #getRequiredPlugin()} + * + * @return The plugin name. */ @Deprecated @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") @@ -240,6 +242,8 @@ public abstract class PlaceholderExpansion extends PlaceholderHook { /** * @deprecated As of versions greater than 2.8.7, use the expansion cloud to show a description + * + * @return The description of the expansion. */ @Deprecated @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") @@ -249,6 +253,8 @@ public abstract class PlaceholderExpansion extends PlaceholderHook { /** * @deprecated As of versions greater than 2.8.7, use the expansion cloud to display a link + * + * @return The link for the expansion. */ @Deprecated @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") From e7e9e81e854a80cc7babd14561935a336c067561 Mon Sep 17 00:00:00 2001 From: Andre_601 <11576465+Andre601@users.noreply.github.com> Date: Mon, 14 Dec 2020 01:04:07 +0100 Subject: [PATCH 2/5] Update VersionSpecific.java --- .../java/me/clip/placeholderapi/expansion/VersionSpecific.java | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/main/java/me/clip/placeholderapi/expansion/VersionSpecific.java b/src/main/java/me/clip/placeholderapi/expansion/VersionSpecific.java index b539532..84d28ba 100644 --- a/src/main/java/me/clip/placeholderapi/expansion/VersionSpecific.java +++ b/src/main/java/me/clip/placeholderapi/expansion/VersionSpecific.java @@ -34,6 +34,8 @@ public interface VersionSpecific { * This method is called before the expansion is attempted to be registered The server version * will be passed to this method so you know what version the server is currently running. * + * @param v The {@link Version} to check against + * * @return true if your expansion is compatible with the version the server is running. */ boolean isCompatibleWith(Version v); From 30a194c75d848fe22364e723250688ad9fd987fd Mon Sep 17 00:00:00 2001 From: Andre_601 <11576465+Andre601@users.noreply.github.com> Date: Mon, 14 Dec 2020 01:08:40 +0100 Subject: [PATCH 3/5] Update PlaceholderAPI.java --- .../java/me/clip/placeholderapi/PlaceholderAPI.java | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/src/main/java/me/clip/placeholderapi/PlaceholderAPI.java b/src/main/java/me/clip/placeholderapi/PlaceholderAPI.java index ea29cfe..f9901b6 100644 --- a/src/main/java/me/clip/placeholderapi/PlaceholderAPI.java +++ b/src/main/java/me/clip/placeholderapi/PlaceholderAPI.java @@ -150,7 +150,7 @@ public final class PlaceholderAPI { /** * set relational placeholders in the text specified placeholders are matched with the pattern - * %% when set with this method + * {@literal %%} when set with this method * * @param one First player to compare * @param two Second player to compare @@ -225,6 +225,8 @@ public final class PlaceholderAPI { /** * Get the normal placeholder pattern. + * + * @return The default Placeholder Pattern */ public static Pattern getPlaceholderPattern() { return PLACEHOLDER_PATTERN; @@ -232,6 +234,8 @@ public final class PlaceholderAPI { /** * Get the bracket placeholder pattern. + * + * @return the Bracket Placeholder Pattern */ public static Pattern getBracketPlaceholderPattern() { return BRACKET_PLACEHOLDER_PATTERN; @@ -239,6 +243,8 @@ public final class PlaceholderAPI { /** * Get the relational placeholder pattern. + * + * @return The Relational Placeholder Pattern */ public static Pattern getRelationalPlaceholderPattern() { return RELATIONAL_PLACEHOLDER_PATTERN; @@ -286,8 +292,7 @@ public final class PlaceholderAPI { * Get map of registered placeholders * * @return Map of registered placeholders - * @deprecated Use {@link me.clip.placeholderapi.PlaceholderAPIPlugin().getLocalExpansionManager() - * .getExpansions()} instead. + * @deprecated Use {@link LocalExpansionManager#getExpansions()} instead. */ @Deprecated @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") From b3893c38db8773935675858a99e234c59fd8db8d Mon Sep 17 00:00:00 2001 From: Andre601 <11576465+Andre601@users.noreply.github.com> Date: Mon, 14 Dec 2020 01:31:40 +0100 Subject: [PATCH 4/5] Hopefully fixing all the JD issues --- .../clip/placeholderapi/PlaceholderAPI.java | 100 ++++++++++++++++-- 1 file changed, 91 insertions(+), 9 deletions(-) diff --git a/src/main/java/me/clip/placeholderapi/PlaceholderAPI.java b/src/main/java/me/clip/placeholderapi/PlaceholderAPI.java index f9901b6..e162d09 100644 --- a/src/main/java/me/clip/placeholderapi/PlaceholderAPI.java +++ b/src/main/java/me/clip/placeholderapi/PlaceholderAPI.java @@ -29,6 +29,7 @@ import java.util.regex.Pattern; import java.util.stream.Collectors; import me.clip.placeholderapi.expansion.PlaceholderExpansion; import me.clip.placeholderapi.expansion.Relational; +import me.clip.placeholderapi.expansion.manager.LocalExpansionManager; import me.clip.placeholderapi.replacer.CharsReplacer; import me.clip.placeholderapi.replacer.Replacer; import me.clip.placeholderapi.replacer.Replacer.Closure; @@ -290,9 +291,10 @@ public final class PlaceholderAPI { /** * Get map of registered placeholders + * + * @deprecated Use {@link LocalExpansionManager#getExpansions()} instead. * * @return Map of registered placeholders - * @deprecated Use {@link LocalExpansionManager#getExpansions()} instead. */ @Deprecated @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") @@ -303,8 +305,12 @@ public final class PlaceholderAPI { } /** - * @deprecated Please use {@link me.clip.placeholderapi.expansion.PlaceholderExpansion} to + * @deprecated Please use {@link PlaceholderExpansion} to * register placeholders instead + * + * @param plugin The Plugin to register with this {@link PlaceholderHook} + * @param placeholderHook The {@link PlaceholderHook} to register + * @return always false */ @Deprecated @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") @@ -317,8 +323,12 @@ public final class PlaceholderAPI { } /** - * @deprecated Please use {@link me.clip.placeholderapi.expansion.PlaceholderExpansion} to + * @deprecated Please use {@link PlaceholderExpansion} to * register placeholders instead + * + * @param identifier The identifier to use for the {@link PlaceholderHook} + * @param placeholderHook The {@link PlaceholderHook} to register + * @return always false */ @Deprecated @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") @@ -330,8 +340,11 @@ public final class PlaceholderAPI { } /** - * @deprecated Please use {@link me.clip.placeholderapi.expansion.PlaceholderExpansion} to + * @deprecated Please use {@link PlaceholderExpansion} to * unregister placeholders instead + * + * @param plugin The plugin to unregister + * @return always false */ @Deprecated @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") @@ -344,8 +357,11 @@ public final class PlaceholderAPI { } /** - * @deprecated Please use {@link me.clip.placeholderapi.expansion.PlaceholderExpansion} to + * @deprecated Please use {@link PlaceholderExpansion} to * unregister placeholders instead + * + * @param identifier The identifier to unregister + * @return always false */ @Deprecated @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") @@ -357,6 +373,8 @@ public final class PlaceholderAPI { /** * @deprecated Will be removed in a future release. + * + * @return Set of registered identifiers */ @Deprecated @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") @@ -366,6 +384,8 @@ public final class PlaceholderAPI { /** * @deprecated Will be removed in a future release. + * + * @return always null */ @Deprecated @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") @@ -375,6 +395,12 @@ public final class PlaceholderAPI { /** * @deprecated Please use {@link #setPlaceholders(OfflinePlayer, String)} instead + * + * @param player The offline player to parse the placeholders against + * @param text The text to parse + * @param pattern The Pattern to use + * @param colorize If PlaceholderAPI should also parse color codes + * @return String with the parsed placeholders */ @Deprecated @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") @@ -385,6 +411,12 @@ public final class PlaceholderAPI { /** * @deprecated Please use {@link #setPlaceholders(OfflinePlayer, List)} instead + * + * @param player The offline player to parse the placeholders against + * @param text The List of text to parse + * @param pattern The Pattern to use + * @param colorize If PlaceholderAPI should also parse color codes + * @return String with the parsed placeholders */ @Deprecated @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") @@ -395,6 +427,11 @@ public final class PlaceholderAPI { /** * @deprecated Use {@link #setPlaceholders(OfflinePlayer, List)} instead. + * + * @param player The offline player to parse the placeholders against + * @param text The List of text to parse + * @param colorize If PlaceholderAPI should also parse color codes + * @return String with the parsed placeholders */ @Deprecated @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") @@ -405,6 +442,11 @@ public final class PlaceholderAPI { /** * @deprecated Use {@link #setPlaceholders(OfflinePlayer, List)} instead. + * + * @param player The offline player to parse the placeholders against + * @param text The List of text to parse + * @param pattern The Pattern to use + * @return String with the parsed placeholders */ @Deprecated @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") @@ -414,6 +456,11 @@ public final class PlaceholderAPI { } /** * @deprecated Will be removed in a future release. + * + * @param player The offline player to parse the placeholders against + * @param text The text to parse + * @param colorize If PlaceholderAPI should also parse color codes + * @return String with the parsed placeholders */ @Deprecated @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") @@ -423,6 +470,11 @@ public final class PlaceholderAPI { /** * @deprecated Will be removed in a future release. + * + * @param player The offline player to parse the placeholders against + * @param text The List of text to parse + * @param colorize If PlaceholderAPI should also parse color codes + * @return String with the parsed placeholders */ @Deprecated @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") @@ -432,6 +484,11 @@ public final class PlaceholderAPI { /** * @deprecated Use {@link #setPlaceholders(OfflinePlayer, String)} instead. + * + * @param player The offline player to parse the placeholders against + * @param text The text to parse + * @param colorize If PlaceholderAPI should also parse color codes + * @return String with the parsed placeholders */ @Deprecated @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") @@ -441,6 +498,11 @@ public final class PlaceholderAPI { /** * @deprecated Use {@link #setPlaceholders(OfflinePlayer, String)} instead. + * + * @param player The offline player to parse the placeholders against + * @param text The text to parse + * @param pattern The Pattern to use + * @return String with the parsed placeholders */ @Deprecated @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") @@ -450,6 +512,11 @@ public final class PlaceholderAPI { /** * @deprecated Use {@link #setPlaceholders(OfflinePlayer, List)} instead. + * + * @param player The offline player to parse the placeholders against + * @param text The List of text to parse + * @param colorize If PlaceholderAPI should also parse color codes + * @return String with the parsed placeholders */ @Deprecated @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") @@ -460,6 +527,11 @@ public final class PlaceholderAPI { /** * @deprecated Use {@link #setPlaceholders(OfflinePlayer, String)} instead. + * + * @param player The offline player to parse the placeholders against + * @param text The text to parse + * @param colorize If PlaceholderAPI should also parse color codes + * @return String with the parsed placeholders */ @Deprecated @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") @@ -469,6 +541,11 @@ public final class PlaceholderAPI { /** * @deprecated Will be removed in a future release. + * + * @param player The offline player to parse the placeholders against + * @param text The text to parse + * @param colorize If PlaceholderAPI should also parse color codes + * @return String with the parsed placeholders */ @Deprecated @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") @@ -478,6 +555,11 @@ public final class PlaceholderAPI { /** * @deprecated Will be removed in a future release. + * + * @param player The offline player to parse the placeholders against + * @param text The List of text to parse + * @param colorize If PlaceholderAPI should also parse color codes + * @return String with the parsed placeholders */ @Deprecated @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") @@ -488,12 +570,12 @@ public final class PlaceholderAPI { /** * set relational placeholders in the text specified placeholders are matched with the pattern - * %% when set with this method + * {@literal %%} when set with this method * * @param one Player to compare * @param two Player to compare * @param text Text to parse the placeholders in - * @param colorize If color codes (&[0-1a-fk-o]) should be translated + * @param colorize If color codes ({@literal &[0-1a-fk-o]}) should be translated * @return The text containing the parsed relational placeholders * @deprecated Use {@link #setPlaceholders(OfflinePlayer, String)} instead. */ @@ -511,9 +593,9 @@ public final class PlaceholderAPI { * @param one First player to compare * @param two Second player to compare * @param text Text to parse the placeholders in - * @param colorize If color codes (&[0-1a-fk-o]) should be translated + * @param colorize If color codes ({@literal &[0-1a-fk-o]}) should be translated * @return The text containing the parsed relational placeholders - * @deprecated Use {@link #setRelationalPlaceholders(Player, Player, List)} instead. + * @deprecated Use {@link #setRelationalPlaceholders(Player, Player, List)} instead. */ @Deprecated @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") From 59cd5982ad7f97e5bf1dabb625561b4ccb5e6dd7 Mon Sep 17 00:00:00 2001 From: Andre601 <11576465+Andre601@users.noreply.github.com> Date: Mon, 14 Dec 2020 01:52:46 +0100 Subject: [PATCH 5/5] Complete fix --- build.gradle | 4 ++++ .../expansion/manager/LocalExpansionManager.java | 8 +------- 2 files changed, 5 insertions(+), 7 deletions(-) diff --git a/build.gradle b/build.gradle index 34b0a3c..36523ca 100644 --- a/build.gradle +++ b/build.gradle @@ -49,6 +49,10 @@ tasks.withType(JavaCompile) { options.encoding = "UTF-8" } +javadoc { + options.encoding = "UTF-8" +} + shadowJar { archiveClassifier.set("") diff --git a/src/main/java/me/clip/placeholderapi/expansion/manager/LocalExpansionManager.java b/src/main/java/me/clip/placeholderapi/expansion/manager/LocalExpansionManager.java index 79f3509..034b651 100644 --- a/src/main/java/me/clip/placeholderapi/expansion/manager/LocalExpansionManager.java +++ b/src/main/java/me/clip/placeholderapi/expansion/manager/LocalExpansionManager.java @@ -173,10 +173,7 @@ public final class LocalExpansionManager implements Listener { return Optional.empty(); } - - /** - * Do not call this method yourself, use {@link PlaceholderExpansion#register()} - */ + @ApiStatus.Internal public boolean register(@NotNull final PlaceholderExpansion expansion) { final String identifier = expansion.getIdentifier().toLowerCase(); @@ -270,9 +267,6 @@ public final class LocalExpansionManager implements Listener { return true; } - /** - * Do not call this method yourself, use {@link PlaceholderExpansion#unregister()} - */ @ApiStatus.Internal public boolean unregister(@NotNull final PlaceholderExpansion expansion) { if (expansions.remove(expansion.getIdentifier()) == null) {