[DOC] Немного правок JavaDoc

This commit is contained in:
Gravit 2019-09-05 19:09:28 +07:00
parent a91135835a
commit 709d75eb80
No known key found for this signature in database
GPG key ID: 061981E1E85D3216
4 changed files with 40 additions and 16 deletions

View file

@ -5,7 +5,13 @@
import pro.gravit.launcher.LauncherNetworkAPI;
import pro.gravit.launcher.request.WebSocketEvent;
/**
* The class of all request events sent by the server to the client
*/
public abstract class RequestEvent implements WebSocketEvent {
/**
* UUID sent in request
*/
@LauncherNetworkAPI
public UUID requestUUID;
}

View file

@ -28,16 +28,28 @@ public LauncherModuleInfo getModuleInfo() {
/**
* Module initialization status at the current time
* CREATED - Module status immediately after loading
* INIT - The state of the module during the execution of the method init()
* FINISH - Status of the module after initialization
*/
public enum InitStatus
{
/**
* When creating an object
*/
CREATED(false),
/**
* After setting the context
*/
PRE_INIT_WAIT(true),
/**
* During the pre-initialization phase
*/
PRE_INIT(false),
/**
* Awaiting initialization phase
*/
INIT_WAIT(true),
/**
* During the initialization phase
*/
INIT(false),
FINISH(true);
@ -96,13 +108,13 @@ public void setContext(LauncherModulesContext context)
/**
* This method is called before initializing all modules and resolving dependencies.
* <b>You can</b>:
* Use to Module Manager
* Add custom modules not described in the manifest
* Change information about your module or modules you control
* - Use to Module Manager
* - Add custom modules not described in the manifest
* - Change information about your module or modules you control
* <b>You can not</b>:
* Use your dependencies
* Use API Launcher, LaunchServer, ServerWrapper
* Change the names of any modules
* - Use your dependencies
* - Use Launcher, LaunchServer, ServerWrapper API
* - Change the names of any modules
*/
public void preInitAction() {
//NOP
@ -119,14 +131,14 @@ public LauncherModule preInit()
/**
* Basic module initialization method
* <b>You can</b>:
* Subscribe to events
* Use your dependencies
* Use provided initContext
* Receive modules and access the modules internal methods
* - Subscribe to events
* - Use your dependencies
* - Use provided initContext
* - Receive modules and access the modules internal methods
* <b>You can not</b>:
* Modify module description, dependencies
* Add modules
* Read configuration
* - Modify module description, dependencies
* - Add modules
* - Read configuration
* @param initContext <b>null</b> on module initialization during boot or startup
* Not <b>null</b> during module initialization while running
*/

View file

@ -7,6 +7,9 @@ public class LauncherModuleInfo {
public final Version version;
public final int priority;
public final String[] dependencies;
/**
* Alternative module names
*/
public final String[] providers;
public LauncherModuleInfo(String name, Version version) {

View file

@ -2,6 +2,9 @@
import pro.gravit.utils.TypeSerializeInterface;
/**
* The interface of all events sent by the server to the client
*/
public interface WebSocketEvent extends TypeSerializeInterface {
String getType();
}