forked from StarOpenSource/Engine
Add missing javadoc
This commit is contained in:
parent
ac3e1e1224
commit
9bc1882de3
GPG key ID:
E366BAEF67E4704D
13 changed files with 48 additions and 6 deletions
|
|
@ -76,6 +76,12 @@ public final class Engine implements SubsystemMainClass {
|
|||
* Indicates if the engine is shutting down.
|
||||
*
|
||||
* @since 1-alpha1
|
||||
*
|
||||
* -- GETTER --
|
||||
* Returns if the engine is shutting down.
|
||||
*
|
||||
* @return if the engine is shutting down
|
||||
* @since 1-alpha1
|
||||
*/
|
||||
@Getter
|
||||
private boolean shuttingDown = false;
|
||||
|
|
|
|||
|
|
@ -88,6 +88,13 @@ public final class EngineConfiguration implements SubsystemConfiguration {
|
|||
*
|
||||
* @see de.staropensource.sosengine.base.classes.helpers.EventHelper#logCall(Class, Object...)
|
||||
* @since 1-alpha0
|
||||
*
|
||||
* -- GETTER --
|
||||
* Gets the value for {@code debugEvents}.
|
||||
*
|
||||
* @return variable value
|
||||
* @see EngineConfiguration#debugEvents
|
||||
* @since 1-alpha0
|
||||
*/
|
||||
private boolean debugEvents;
|
||||
|
||||
|
|
@ -190,14 +197,14 @@ public final class EngineConfiguration implements SubsystemConfiguration {
|
|||
* Only applies if {@code optimizeLogging} is turned on.
|
||||
*
|
||||
* @see EngineConfiguration#optimizeLogging
|
||||
* @since 1-alpha0
|
||||
* @since 1-alpha1
|
||||
*
|
||||
* -- GETTER --
|
||||
* Gets the value for {@code loggerForceStandardOutput}.
|
||||
*
|
||||
* @return variable value
|
||||
* @see EngineConfiguration#loggerForceStandardOutput
|
||||
* @since 1-alpha0
|
||||
* @since 1-alpha1
|
||||
*/
|
||||
private int loggerPollingSpeed;
|
||||
|
||||
|
|
|
|||
|
|
@ -60,7 +60,8 @@ public class EventHelper {
|
|||
/**
|
||||
* Logs the event call.
|
||||
*
|
||||
* @param clazz event class
|
||||
* @param clazz event class
|
||||
* @param arguments arguments passed to event listeners
|
||||
* @since 1-alpha0
|
||||
*/
|
||||
public static void logCall(@NotNull Class<? extends Event> clazz, @NotNull Object ... arguments) {
|
||||
|
|
|
|||
|
|
@ -105,7 +105,7 @@ public final class Logger {
|
|||
* Starts the logging thread.
|
||||
*
|
||||
* @since 1-alpha1
|
||||
* @see Logger#getLoggingThread()
|
||||
* @see Logger#loggingThread
|
||||
*/
|
||||
public static void startLoggingThread() {
|
||||
if (loggingThread == null) {
|
||||
|
|
|
|||
|
|
@ -33,6 +33,11 @@ import java.util.Set;
|
|||
*/
|
||||
@SuppressWarnings({ "unused" })
|
||||
public class ListFormatter {
|
||||
/**
|
||||
* Constructor.
|
||||
*/
|
||||
public ListFormatter() {}
|
||||
|
||||
/**
|
||||
* Converts an array to a {@link String}.
|
||||
*
|
||||
|
|
|
|||
|
|
@ -57,7 +57,7 @@ public final class Miscellaneous {
|
|||
|
||||
/**
|
||||
* Forcefully invokes the garbage collector and blocks execution until finished.<br/>
|
||||
* If you want to run it in parallel to your program, consider running it in a {@link VirtualThread}.
|
||||
* If you want to run it in parallel to your program, consider running it in a {@link java.lang.VirtualThread}.
|
||||
*
|
||||
* @since 1-alpha0
|
||||
*/
|
||||
|
|
@ -88,6 +88,7 @@ public final class Miscellaneous {
|
|||
*
|
||||
* @param map map to use
|
||||
* @param value value to search for
|
||||
* @return all keys matching the specified value
|
||||
* @since 1-alpha0
|
||||
*/
|
||||
public static Set<?> getMapValue(@NotNull Map<?, ?> map, @Nullable Object value) {
|
||||
|
|
|
|||
|
|
@ -31,6 +31,11 @@ import org.jetbrains.annotations.NotNull;
|
|||
*/
|
||||
@SuppressWarnings({ "unused" })
|
||||
public final class OpenGlManagement implements ApiManagementClass {
|
||||
/**
|
||||
* Constructor.
|
||||
*/
|
||||
public OpenGlManagement() {}
|
||||
|
||||
/** {@inheritDoc} */
|
||||
@NotNull
|
||||
@Override
|
||||
|
|
|
|||
|
|
@ -44,6 +44,7 @@ public interface ApiMainClass extends SubsystemMainClass {
|
|||
/**
|
||||
* Returns the name of the Graphics API.
|
||||
*
|
||||
* @return Graphics API name
|
||||
* @since 1-alpha0
|
||||
*/
|
||||
String getApiName();
|
||||
|
|
|
|||
|
|
@ -32,6 +32,9 @@ public interface ApiManagementClass {
|
|||
/**
|
||||
* Creates a new {@link Window}.
|
||||
*
|
||||
* @param title initial window title
|
||||
* @param size initial window size
|
||||
* @return new window
|
||||
* @since 1-alpha0
|
||||
*/
|
||||
@NotNull
|
||||
|
|
|
|||
|
|
@ -25,6 +25,11 @@ import de.staropensource.sosengine.graphics.classes.Window;
|
|||
import org.jetbrains.annotations.NotNull;
|
||||
|
||||
public class VulkanManagement implements ApiManagementClass {
|
||||
/**
|
||||
* Constructor.
|
||||
*/
|
||||
public VulkanManagement() {}
|
||||
|
||||
/** {@inheritDoc} */
|
||||
@NotNull
|
||||
@Override
|
||||
|
|
|
|||
|
|
@ -89,7 +89,7 @@ public final class VulkanSubsystem implements ApiMainClass {
|
|||
}
|
||||
|
||||
// Warn about instability
|
||||
logger.warn("The Vulkan Graphics API is unfinished. Trying to initialize it will lead to an engine crash.");
|
||||
logger.warn("The Vulkan Graphics API is in an unfinished state. Trying to initialize the Graphics API will cause an engine crash.");
|
||||
|
||||
// Register Graphics API
|
||||
GraphicsSubsystem.getInstance().registerGraphicsApi(this);
|
||||
|
|
|
|||
|
|
@ -33,6 +33,9 @@ import java.util.concurrent.ConcurrentMap;
|
|||
public class CompatibilityLoggerFactory implements ILoggerFactory {
|
||||
ConcurrentMap<@NotNull String, @NotNull Logger> loggerMap;
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
*/
|
||||
public CompatibilityLoggerFactory() {
|
||||
loggerMap = new ConcurrentHashMap<>();
|
||||
CompatibilityLogger.lazyInit();
|
||||
|
|
|
|||
|
|
@ -73,6 +73,11 @@ public class CompatibilityLoggerProvider implements SLF4JServiceProvider {
|
|||
*/
|
||||
private MDCAdapter mDCAdapter;
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
*/
|
||||
public CompatibilityLoggerProvider() {}
|
||||
|
||||
/** {@inheritDoc} */
|
||||
@Override
|
||||
public void initialize() {
|
||||
|
|
|
|||
Loading…
Reference in a new issue