From 27f63500765d2e3c38c007fadacde2c7b77b9ecc Mon Sep 17 00:00:00 2001 From: Rsl1122 Date: Mon, 5 Aug 2019 10:25:00 +0300 Subject: [PATCH] Fixed javadoc errors Affects issues: - #993 --- .../java/com/djrapitops/plan/extension/NotReadyException.java | 2 +- .../djrapitops/plan/extension/annotation/BooleanProvider.java | 4 ++-- .../com/djrapitops/plan/extension/annotation/Conditional.java | 2 +- .../djrapitops/plan/extension/annotation/DoubleProvider.java | 4 ++-- .../djrapitops/plan/extension/annotation/NumberProvider.java | 4 ++-- .../plan/extension/annotation/PercentageProvider.java | 4 ++-- .../com/djrapitops/plan/extension/annotation/PluginInfo.java | 4 ++-- .../djrapitops/plan/extension/annotation/StringProvider.java | 4 ++-- .../com/djrapitops/plan/extension/annotation/TabInfo.java | 4 ++-- .../main/java/com/djrapitops/plan/extension/icon/Icon.java | 2 +- .../src/main/java/com/djrapitops/plan/query/QueryService.java | 4 ++-- .../api/exceptions/connection/TransferDatabaseException.java | 4 +++- .../RemoveUnsatisfiedConditionalPlayerResultsTransaction.java | 2 +- .../RemoveUnsatisfiedConditionalServerResultsTransaction.java | 2 +- 14 files changed, 24 insertions(+), 22 deletions(-) diff --git a/Plan/api/src/main/java/com/djrapitops/plan/extension/NotReadyException.java b/Plan/api/src/main/java/com/djrapitops/plan/extension/NotReadyException.java index b675994bb..22f3b34ea 100644 --- a/Plan/api/src/main/java/com/djrapitops/plan/extension/NotReadyException.java +++ b/Plan/api/src/main/java/com/djrapitops/plan/extension/NotReadyException.java @@ -21,7 +21,7 @@ package com.djrapitops.plan.extension; *

* This Exception will not cause Plan to "yell" about the exception. *

- * Requires {@link com.djrapitops.plan.capability.Capability#DATA_EXTENSION_NOT_READY_EXCEPTION}. + * Requires Capability#DATA_EXTENSION_NOT_READY_EXCEPTION. * * @author Rsl1122 */ diff --git a/Plan/api/src/main/java/com/djrapitops/plan/extension/annotation/BooleanProvider.java b/Plan/api/src/main/java/com/djrapitops/plan/extension/annotation/BooleanProvider.java index e3fa4c97f..8eb5d2da5 100644 --- a/Plan/api/src/main/java/com/djrapitops/plan/extension/annotation/BooleanProvider.java +++ b/Plan/api/src/main/java/com/djrapitops/plan/extension/annotation/BooleanProvider.java @@ -89,7 +89,7 @@ public @interface BooleanProvider { /** * Name of Font Awesome icon. *

- * See https://fontawesome.com/icons?d=gallery&m=free for icons and their {@link Family}. + * See https://fontawesome.com/icons (select 'free')) for icons and their {@link Family}. * * @return Name of the icon, if name is not valid no icon is shown. */ @@ -98,7 +98,7 @@ public @interface BooleanProvider { /** * Family of Font Awesome icon. *

- * See https://fontawesome.com/icons?d=gallery&m=free for icons and their {@link Family}. + * See https://fontawesome.com/icons (select 'free')) for icons and their {@link Family}. * * @return Family that matches an icon, if there is no icon for this family no icon is shown. */ diff --git a/Plan/api/src/main/java/com/djrapitops/plan/extension/annotation/Conditional.java b/Plan/api/src/main/java/com/djrapitops/plan/extension/annotation/Conditional.java index ec70f95d6..ecc87b070 100644 --- a/Plan/api/src/main/java/com/djrapitops/plan/extension/annotation/Conditional.java +++ b/Plan/api/src/main/java/com/djrapitops/plan/extension/annotation/Conditional.java @@ -24,7 +24,7 @@ import java.lang.annotation.Target; /** * Method Annotation to determine that a method can not be called unless a condition is fulfilled. *

- * Condition information is provided with {@link com.djrapitops.plan.extension.annotation.data.BooleanProvider}. + * Condition information is provided with {@link com.djrapitops.plan.extension.annotation.BooleanProvider}. * If {@link com.djrapitops.plan.extension.annotation.BooleanProvider} for the condition is not specified the * method tagged with this annotation will not be called, (Condition is assumed false). * diff --git a/Plan/api/src/main/java/com/djrapitops/plan/extension/annotation/DoubleProvider.java b/Plan/api/src/main/java/com/djrapitops/plan/extension/annotation/DoubleProvider.java index 7f7035e85..df004701e 100644 --- a/Plan/api/src/main/java/com/djrapitops/plan/extension/annotation/DoubleProvider.java +++ b/Plan/api/src/main/java/com/djrapitops/plan/extension/annotation/DoubleProvider.java @@ -67,7 +67,7 @@ public @interface DoubleProvider { /** * Name of Font Awesome icon. *

- * See https://fontawesome.com/icons?d=gallery&m=free for icons and their {@link Family}. + * See https://fontawesome.com/icons (select 'free')) for icons and their {@link Family}. * * @return Name of the icon, if name is not valid no icon is shown. */ @@ -76,7 +76,7 @@ public @interface DoubleProvider { /** * Family of Font Awesome icon. *

- * See https://fontawesome.com/icons?d=gallery&m=free for icons and their {@link Family}. + * See https://fontawesome.com/icons (select 'free')) for icons and their {@link Family}. * * @return Family that matches an icon, if there is no icon for this family no icon is shown. */ diff --git a/Plan/api/src/main/java/com/djrapitops/plan/extension/annotation/NumberProvider.java b/Plan/api/src/main/java/com/djrapitops/plan/extension/annotation/NumberProvider.java index 9f682f0f1..6f1a57e1d 100644 --- a/Plan/api/src/main/java/com/djrapitops/plan/extension/annotation/NumberProvider.java +++ b/Plan/api/src/main/java/com/djrapitops/plan/extension/annotation/NumberProvider.java @@ -79,7 +79,7 @@ public @interface NumberProvider { /** * Name of Font Awesome icon. *

- * See https://fontawesome.com/icons?d=gallery&m=free for icons and their {@link Family}. + * See https://fontawesome.com/icons (select 'free')) for icons and their {@link Family}. * * @return Name of the icon, if name is not valid no icon is shown. */ @@ -88,7 +88,7 @@ public @interface NumberProvider { /** * Family of Font Awesome icon. *

- * See https://fontawesome.com/icons?d=gallery&m=free for icons and their {@link Family}. + * See https://fontawesome.com/icons (select 'free')) for icons and their {@link Family}. * * @return Family that matches an icon, if there is no icon for this family no icon is shown. */ diff --git a/Plan/api/src/main/java/com/djrapitops/plan/extension/annotation/PercentageProvider.java b/Plan/api/src/main/java/com/djrapitops/plan/extension/annotation/PercentageProvider.java index 2f1cd94c3..68da86301 100644 --- a/Plan/api/src/main/java/com/djrapitops/plan/extension/annotation/PercentageProvider.java +++ b/Plan/api/src/main/java/com/djrapitops/plan/extension/annotation/PercentageProvider.java @@ -70,7 +70,7 @@ public @interface PercentageProvider { /** * Name of Font Awesome icon. *

- * See https://fontawesome.com/icons?d=gallery&m=free for icons and their {@link Family}. + * See https://fontawesome.com/icons (select 'free')) for icons and their {@link Family}. * * @return Name of the icon, if name is not valid no icon is shown. */ @@ -79,7 +79,7 @@ public @interface PercentageProvider { /** * Family of Font Awesome icon. *

- * See https://fontawesome.com/icons?d=gallery&m=free for icons and their {@link Family}. + * See https://fontawesome.com/icons (select 'free')) for icons and their {@link Family}. * * @return Family that matches an icon, if there is no icon for this family no icon is shown. */ diff --git a/Plan/api/src/main/java/com/djrapitops/plan/extension/annotation/PluginInfo.java b/Plan/api/src/main/java/com/djrapitops/plan/extension/annotation/PluginInfo.java index d7f08e0b3..908380921 100644 --- a/Plan/api/src/main/java/com/djrapitops/plan/extension/annotation/PluginInfo.java +++ b/Plan/api/src/main/java/com/djrapitops/plan/extension/annotation/PluginInfo.java @@ -44,7 +44,7 @@ public @interface PluginInfo { /** * Name of Font Awesome icon. *

- * See https://fontawesome.com/icons?d=gallery&m=free for icons and their {@link Family}. + * See https://fontawesome.com/icons (select 'free')) for icons and their {@link Family}. * * @return Name of the icon, if name is not valid no icon is shown. */ @@ -53,7 +53,7 @@ public @interface PluginInfo { /** * Family of Font Awesome icon. *

- * See https://fontawesome.com/icons?d=gallery&m=free for icons and their {@link Family}. + * See https://fontawesome.com/icons (select 'free')) for icons and their {@link Family}. * * @return Family that matches an icon, if there is no icon for this family no icon is shown. */ diff --git a/Plan/api/src/main/java/com/djrapitops/plan/extension/annotation/StringProvider.java b/Plan/api/src/main/java/com/djrapitops/plan/extension/annotation/StringProvider.java index a2fcd980a..6b0cfd7d7 100644 --- a/Plan/api/src/main/java/com/djrapitops/plan/extension/annotation/StringProvider.java +++ b/Plan/api/src/main/java/com/djrapitops/plan/extension/annotation/StringProvider.java @@ -79,7 +79,7 @@ public @interface StringProvider { /** * Name of Font Awesome icon. *

- * See https://fontawesome.com/icons?d=gallery&m=free for icons and their {@link Family}. + * See https://fontawesome.com/icons (select 'free')) for icons and their {@link Family}. * * @return Name of the icon, if name is not valid no icon is shown. */ @@ -88,7 +88,7 @@ public @interface StringProvider { /** * Family of Font Awesome icon. *

- * See https://fontawesome.com/icons?d=gallery&m=free for icons and their {@link Family}. + * See https://fontawesome.com/icons (select 'free')) for icons and their {@link Family}. * * @return Family that matches an icon, if there is no icon for this family no icon is shown. */ diff --git a/Plan/api/src/main/java/com/djrapitops/plan/extension/annotation/TabInfo.java b/Plan/api/src/main/java/com/djrapitops/plan/extension/annotation/TabInfo.java index bcae41fd5..d0b555f6f 100644 --- a/Plan/api/src/main/java/com/djrapitops/plan/extension/annotation/TabInfo.java +++ b/Plan/api/src/main/java/com/djrapitops/plan/extension/annotation/TabInfo.java @@ -41,7 +41,7 @@ public @interface TabInfo { /** * Name of Font Awesome icon. *

- * See https://fontawesome.com/icons?d=gallery&m=free for icons and their {@link Family}. + * See https://fontawesome.com/icons (select 'free')) for icons and their {@link Family}. * * @return Name of the icon, if name is not valid no icon is shown. */ @@ -50,7 +50,7 @@ public @interface TabInfo { /** * Family of Font Awesome icon. *

- * See https://fontawesome.com/icons?d=gallery&m=free for icons and their {@link Family}. + * See https://fontawesome.com/icons (select 'free')) for icons and their {@link Family}. * * @return Family that matches an icon, if there is no icon for this family no icon is shown. */ diff --git a/Plan/api/src/main/java/com/djrapitops/plan/extension/icon/Icon.java b/Plan/api/src/main/java/com/djrapitops/plan/extension/icon/Icon.java index 8fc722d13..5fb858292 100644 --- a/Plan/api/src/main/java/com/djrapitops/plan/extension/icon/Icon.java +++ b/Plan/api/src/main/java/com/djrapitops/plan/extension/icon/Icon.java @@ -19,7 +19,7 @@ package com.djrapitops.plan.extension.icon; /** * Object that represents an icon on the website. *

- * See https://fontawesome.com/icons?d=gallery&m=free for icons and their {@link Family}. + * See https://fontawesome.com/icons (select 'free')) for icons and their {@link Family}. * * @author Rsl1122 */ diff --git a/Plan/api/src/main/java/com/djrapitops/plan/query/QueryService.java b/Plan/api/src/main/java/com/djrapitops/plan/query/QueryService.java index f159d6ff5..76eee4f98 100644 --- a/Plan/api/src/main/java/com/djrapitops/plan/query/QueryService.java +++ b/Plan/api/src/main/java/com/djrapitops/plan/query/QueryService.java @@ -91,7 +91,7 @@ public interface QueryService { * SQL for removing this player's data should be executed when this occurs. *

* Example usage: - * subscribeToPlayerRemoveEvent(playerUUID -> { do stuff }) + * {@code subscribeToPlayerRemoveEvent(playerUUID -> { do stuff })} * * @param eventListener Functional interface that is called on the event. */ @@ -103,7 +103,7 @@ public interface QueryService { * SQL for removing all extra tables (and data) should be performed *

* Example usage: - * subscribeDataClearEvent(() -> { do stuff }) + * {@code subscribeDataClearEvent(() -> { do stuff })} * * @param eventListener Functional interface that is called on the event. */ diff --git a/Plan/common/src/main/java/com/djrapitops/plan/api/exceptions/connection/TransferDatabaseException.java b/Plan/common/src/main/java/com/djrapitops/plan/api/exceptions/connection/TransferDatabaseException.java index e597da18b..55e9f45f6 100644 --- a/Plan/common/src/main/java/com/djrapitops/plan/api/exceptions/connection/TransferDatabaseException.java +++ b/Plan/common/src/main/java/com/djrapitops/plan/api/exceptions/connection/TransferDatabaseException.java @@ -16,8 +16,10 @@ */ package com.djrapitops.plan.api.exceptions.connection; +import com.djrapitops.plan.system.info.request.InfoRequest; + /** - * Thrown when {@link com.djrapitops.plan.api.exceptions.database.DBOpException} occurs during {@link com.djrapitops.plan.system.info.request.InfoRequest#placeIntoDatabase}. + * Thrown when {@link com.djrapitops.plan.api.exceptions.database.DBOpException} occurs during {@link InfoRequest#runLocally()}. * * @author Rsl1122 */ diff --git a/Plan/common/src/main/java/com/djrapitops/plan/extension/implementation/storage/transactions/results/RemoveUnsatisfiedConditionalPlayerResultsTransaction.java b/Plan/common/src/main/java/com/djrapitops/plan/extension/implementation/storage/transactions/results/RemoveUnsatisfiedConditionalPlayerResultsTransaction.java index 9f729a432..8bbda64c4 100644 --- a/Plan/common/src/main/java/com/djrapitops/plan/extension/implementation/storage/transactions/results/RemoveUnsatisfiedConditionalPlayerResultsTransaction.java +++ b/Plan/common/src/main/java/com/djrapitops/plan/extension/implementation/storage/transactions/results/RemoveUnsatisfiedConditionalPlayerResultsTransaction.java @@ -35,7 +35,7 @@ import static com.djrapitops.plan.db.sql.parsing.Sql.*; *

* How it works: * - Select all fulfilled conditions for all players (conditionName when true and not_conditionName when false) - * - Left join with player value & provider tables when uuids match, and when condition matches a condition in the query above. + * - Left join with player value and provider tables when uuids match, and when condition matches a condition in the query above. * - Filter the join query for values where the condition did not match any provided condition in the join (Is null) * - Delete all player values with IDs that are returned by the left join query after filtering * diff --git a/Plan/common/src/main/java/com/djrapitops/plan/extension/implementation/storage/transactions/results/RemoveUnsatisfiedConditionalServerResultsTransaction.java b/Plan/common/src/main/java/com/djrapitops/plan/extension/implementation/storage/transactions/results/RemoveUnsatisfiedConditionalServerResultsTransaction.java index e03b36aaa..2718ef6f9 100644 --- a/Plan/common/src/main/java/com/djrapitops/plan/extension/implementation/storage/transactions/results/RemoveUnsatisfiedConditionalServerResultsTransaction.java +++ b/Plan/common/src/main/java/com/djrapitops/plan/extension/implementation/storage/transactions/results/RemoveUnsatisfiedConditionalServerResultsTransaction.java @@ -35,7 +35,7 @@ import static com.djrapitops.plan.db.sql.parsing.Sql.*; *

* How it works: * - Select all fulfilled conditions for all servers (conditionName when true and not_conditionName when false) - * - Left join with server value & provider tables when plugin_ids match, and when condition matches a condition in the + * - Left join with server value and provider tables when plugin_ids match, and when condition matches a condition in the * query above. (plugin_ids can be linked to servers) * - Filter the join query for values where the condition did not match any provided condition in the join (Is null) * - Delete all server values with IDs that are returned by the left join query after filtering