Upstream/Plan
1
0
Fork 0
mirror of https://github.com/plan-player-analytics/Plan.git synced 2025-04-15 00:26:20 +02:00
Code Issues Projects Releases Wiki Activity

Fixed javadoc errors

Browse Source 
Affects issues:
- #993
This commit is contained in:
Rsl1122 2019-08-05 10:25:00 +03:00
parent b3bcea4798
commit 27f6350076
14 changed files with 24 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Plan/api/src/main/java/com/djrapitops/plan/extension/NotReadyException.java
View File

@ -21,7 +21,7 @@ package com.djrapitops.plan.extension;
* <p>
* This Exception will not cause Plan to "yell" about the exception.
* <p>
* Requires {@link com.djrapitops.plan.capability.Capability#DATA_EXTENSION_NOT_READY_EXCEPTION}.
* Requires Capability#DATA_EXTENSION_NOT_READY_EXCEPTION.
*
* @author Rsl1122
*/

4
Plan/api/src/main/java/com/djrapitops/plan/extension/annotation/BooleanProvider.java
View File

@ -89,7 +89,7 @@ public @interface BooleanProvider {
/**
* Name of Font Awesome icon.
* <p>
* 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.
* <p>
* 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.
*/

2
Plan/api/src/main/java/com/djrapitops/plan/extension/annotation/Conditional.java
View File

@ -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.
* <p>
* 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).
*

4
Plan/api/src/main/java/com/djrapitops/plan/extension/annotation/DoubleProvider.java
View File

@ -67,7 +67,7 @@ public @interface DoubleProvider {
/**
* Name of Font Awesome icon.
* <p>
* 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.
* <p>
* 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.
*/

4
Plan/api/src/main/java/com/djrapitops/plan/extension/annotation/NumberProvider.java
View File

@ -79,7 +79,7 @@ public @interface NumberProvider {
/**
* Name of Font Awesome icon.
* <p>
* 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.
* <p>
* 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.
*/

4
Plan/api/src/main/java/com/djrapitops/plan/extension/annotation/PercentageProvider.java
View File

@ -70,7 +70,7 @@ public @interface PercentageProvider {
/**
* Name of Font Awesome icon.
* <p>
* 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.
* <p>
* 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.
*/

4
Plan/api/src/main/java/com/djrapitops/plan/extension/annotation/PluginInfo.java
View File

@ -44,7 +44,7 @@ public @interface PluginInfo {
/**
* Name of Font Awesome icon.
* <p>
* 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.
* <p>
* 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.
*/

4
Plan/api/src/main/java/com/djrapitops/plan/extension/annotation/StringProvider.java
View File

@ -79,7 +79,7 @@ public @interface StringProvider {
/**
* Name of Font Awesome icon.
* <p>
* 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.
* <p>
* 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.
*/

4
Plan/api/src/main/java/com/djrapitops/plan/extension/annotation/TabInfo.java
View File

@ -41,7 +41,7 @@ public @interface TabInfo {
/**
* Name of Font Awesome icon.
* <p>
* 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.
* <p>
* 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.
*/

2
Plan/api/src/main/java/com/djrapitops/plan/extension/icon/Icon.java
View File

@ -19,7 +19,7 @@ package com.djrapitops.plan.extension.icon;
/**
* Object that represents an icon on the website.
* <p>
* 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
*/

4
Plan/api/src/main/java/com/djrapitops/plan/query/QueryService.java
View File

@ -91,7 +91,7 @@ public interface QueryService {
* SQL for removing this player's data should be executed when this occurs.
* <p>
* 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
* <p>
* Example usage:
* subscribeDataClearEvent(() -> { do stuff })
* {@code subscribeDataClearEvent(() -> { do stuff })}
*
* @param eventListener Functional interface that is called on the event.
*/

4
Plan/common/src/main/java/com/djrapitops/plan/api/exceptions/connection/TransferDatabaseException.java
View File

@ -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
*/

2
Plan/common/src/main/java/com/djrapitops/plan/extension/implementation/storage/transactions/results/RemoveUnsatisfiedConditionalPlayerResultsTransaction.java
View File

@ -35,7 +35,7 @@ import static com.djrapitops.plan.db.sql.parsing.Sql.*;
* <p>
* 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
*

2
Plan/common/src/main/java/com/djrapitops/plan/extension/implementation/storage/transactions/results/RemoveUnsatisfiedConditionalServerResultsTransaction.java
View File

@ -35,7 +35,7 @@ import static com.djrapitops.plan.db.sql.parsing.Sql.*;
* <p>
* 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