Pulling all pending Bukkit-JavaDoc changes
By: Edmond Poon <sagaciouszzzz@gmail.com>
This commit is contained in:
@ -50,6 +50,7 @@ public @interface Warning {
|
||||
|
||||
/**
|
||||
* This method checks the provided warning should be printed for this state
|
||||
*
|
||||
* @param warning The warning annotation added to a deprecated item
|
||||
* @return ON is always True<br>
|
||||
* OFF is always false<br>
|
||||
@ -64,6 +65,7 @@ public @interface Warning {
|
||||
|
||||
/**
|
||||
* This method returns the corresponding warning state for the given string value.
|
||||
*
|
||||
* @param value The string value to check
|
||||
* @return {@link #DEFAULT} if not found, or the respective WarningState
|
||||
*/
|
||||
@ -81,12 +83,14 @@ public @interface Warning {
|
||||
|
||||
/**
|
||||
* This sets if the deprecation warnings when registering events gets printed when the setting is in the default state.
|
||||
*
|
||||
* @return false normally, or true to encourage warning printout
|
||||
*/
|
||||
boolean value() default false;
|
||||
|
||||
/**
|
||||
* This can provide detailed information on why the event is deprecated.
|
||||
*
|
||||
* @return The reason an event is deprecated
|
||||
*/
|
||||
String reason() default "";
|
||||
|
||||
Reference in New Issue
Block a user