forked from StarOpenSource/Engine
Shorten width of variable descriptions
This commit is contained in:
parent
0fbfe8f4e3
commit
0fed87328a
GPG key ID:
E366BAEF67E4704D
2 changed files with 53 additions and 30 deletions
|
|
@ -27,6 +27,7 @@ import de.staropensource.sosengine.base.logging.LoggingThread;
|
|||
import de.staropensource.sosengine.base.type.EngineState;
|
||||
import de.staropensource.sosengine.base.type.logging.LogLevel;
|
||||
import de.staropensource.sosengine.base.type.vector.Vec2f;
|
||||
import de.staropensource.sosengine.base.type.vector.Vec2i;
|
||||
import de.staropensource.sosengine.base.utility.PropertiesReader;
|
||||
import lombok.Getter;
|
||||
import org.jetbrains.annotations.NotNull;
|
||||
|
|
@ -81,8 +82,9 @@ public final class EngineConfiguration extends Configuration {
|
|||
private final @NotNull String group = "sosengine.base.";
|
||||
|
||||
/**
|
||||
* If enabled, allows for unintentional behaviour and excess logging.
|
||||
* Unless you want to debug or work on a sensitive part of the engine, don't enable this!
|
||||
* If enabled, allows for unintentional behaviour
|
||||
* and excess logging. Unless you want to debug or work
|
||||
* on a sensitive part of the engine, don't enable this!
|
||||
*
|
||||
* @since v1-alpha0
|
||||
* -- GETTER --
|
||||
|
|
@ -168,8 +170,9 @@ public final class EngineConfiguration extends Configuration {
|
|||
private boolean errorShortcodeConverter;
|
||||
|
||||
/**
|
||||
* If enabled, will makes the {@link Logger} work asynchronous, in a separate platform thread.
|
||||
* Don't disable unless you want your application to run <b>extremely</b> slowly.
|
||||
* If enabled, will makes the {@link Logger} work asynchronous,
|
||||
* in a separate platform thread. Don't disable unless you want
|
||||
* your application to run <b>extremely</b> slowly.
|
||||
*
|
||||
* @see #loggerPollingSpeed
|
||||
* @see Thread
|
||||
|
|
@ -184,8 +187,9 @@ public final class EngineConfiguration extends Configuration {
|
|||
private boolean optimizeLogging;
|
||||
|
||||
/**
|
||||
* If enabled, will make all events asynchronous, in separate virtual threads.
|
||||
* Don't disable unless you want your application to run slower.
|
||||
* If enabled, will make all events asynchronous,
|
||||
* in separate virtual threads. Don't disable unless you
|
||||
* want your application to run slower.
|
||||
*
|
||||
* @see VirtualThread
|
||||
* @since v1-alpha0
|
||||
|
|
@ -199,12 +203,14 @@ public final class EngineConfiguration extends Configuration {
|
|||
private boolean optimizeEvents;
|
||||
|
||||
/**
|
||||
* If enabled, will try to automatically initialize every subsystem found though reflection.
|
||||
* If enabled, will try to automatically initialize every
|
||||
* subsystem found though reflection.
|
||||
* <p>
|
||||
* This however may fail in certain situation, where manual subsystem initialization may be required.
|
||||
* For this reason, this can be turned off before the engine initializes.
|
||||
* Please note though that dependency resolution between subsystems will not be done, be careful when
|
||||
* initializing subsystems manually.
|
||||
* This however may fail in certain situation, where manual
|
||||
* subsystem initialization may be required. For this reason,
|
||||
* this can be turned off before the engine initializes. Please
|
||||
* note though that dependency resolution between subsystems
|
||||
* won't be performed, be careful when initializing subsystems manually.
|
||||
*
|
||||
* @see Engine
|
||||
* @since v1-alpha2
|
||||
|
|
@ -218,7 +224,8 @@ public final class EngineConfiguration extends Configuration {
|
|||
private boolean optimizeSubsystemInitialization;
|
||||
|
||||
/**
|
||||
* Contains which logger levels are allowed by setting the minimum logger level.
|
||||
* Contains which logger levels are allowed
|
||||
* by setting the minimum logger level.
|
||||
*
|
||||
* @see Logger
|
||||
* @since v1-alpha0
|
||||
|
|
@ -246,12 +253,14 @@ public final class EngineConfiguration extends Configuration {
|
|||
private String loggerTemplate;
|
||||
|
||||
/**
|
||||
* Contains how fast the logging thread will poll for queued messages.
|
||||
* This also causes messages to be buffered.
|
||||
* Contains how fast the logging thread will
|
||||
* poll for queued messages. This also causes
|
||||
* messages to be buffered.
|
||||
* <p>
|
||||
* Only applies if {@code optimizeLogging} is turned on.
|
||||
* Values below {@code 1} will poll for queued messages as fast as it can.
|
||||
* This however has pretty much no benefit. Leave it at {@code 5}, it works quite well.
|
||||
* Values below {@code 1} will poll for queued
|
||||
* messages as fast as it can. This however has pretty much
|
||||
* no benefit. Leave it at {@code 5}, it works quite well.
|
||||
*
|
||||
* @see #optimizeLogging
|
||||
* @since v1-alpha4
|
||||
|
|
@ -265,8 +274,10 @@ public final class EngineConfiguration extends Configuration {
|
|||
private int loggerPollingSpeed;
|
||||
|
||||
/**
|
||||
* If enabled, will force the {@link Logger} and {@link CrashHandler} to use <a href="https://www.man7.org/linux/man-pages/man3/stderr.3.html">the standard output</a>
|
||||
* instead of <a href="https://www.man7.org/linux/man-pages/man3/stderr.3.html">the standard error</a> for logging {@code ERROR} and {@code CRASH}.
|
||||
* If enabled, will force the {@link Logger} and {@link CrashHandler} to use
|
||||
* <a href="https://www.man7.org/linux/man-pages/man3/stderr.3.html">the standard output</a>
|
||||
* instead of <a href="https://www.man7.org/linux/man-pages/man3/stderr.3.html">the standard error</a>
|
||||
* for logging {@code ERROR} and {@code CRASH}.
|
||||
*
|
||||
* @since v1-alpha0
|
||||
* -- GETTER --
|
||||
|
|
@ -279,9 +290,14 @@ public final class EngineConfiguration extends Configuration {
|
|||
private boolean loggerForceStandardOutput;
|
||||
|
||||
/**
|
||||
* If enabled, will enable support for printing log messages on multiple lines.
|
||||
* By enabling this configuration setting, logger throughput will be decreased slightly when encountering a log message with newlines found in it.
|
||||
* This performance hit is negligible though and should not affect application performance, especially with logger multi-threading turned on (see {@link #optimizeLogging}).
|
||||
* If enabled, will enable support for printing
|
||||
* log messages on multiple lines. By enabling this
|
||||
* configuration setting, logger throughput will be
|
||||
* decreased slightly when encountering a log message
|
||||
* with newlines found in it. This performance hit is
|
||||
* negligible though and should not affect application
|
||||
* performance, especially with logger multi-threading
|
||||
* turned on (see {@link #optimizeLogging}).
|
||||
*
|
||||
* @since v1-alpha4
|
||||
* -- GETTER --
|
||||
|
|
@ -294,8 +310,11 @@ public final class EngineConfiguration extends Configuration {
|
|||
private boolean loggerEnableNewlineSupport;
|
||||
|
||||
/**
|
||||
* If enabled, the JVM will immediately shutdown on an engine crash. This will prevent shutdown hooks from executing.
|
||||
* Note: This will also prevent Jansi and potentially other libraries from removing temporary native libraries at shutdown.
|
||||
* If enabled, the JVM will be shutdown immediately
|
||||
* after printing a fatal crash report. This will
|
||||
* prevent shutdown hooks from executing.
|
||||
* Note: This will also prevent Jansi and potentially other libraries
|
||||
* from removing temporary native libraries at shutdown.
|
||||
*
|
||||
* @see CrashHandler
|
||||
* @since v1-alpha0
|
||||
|
|
@ -309,12 +328,18 @@ public final class EngineConfiguration extends Configuration {
|
|||
private boolean loggerImmediateShutdown;
|
||||
|
||||
/**
|
||||
* Will truncate the path of types when using their {@code toString} method.
|
||||
* Will truncate the path of types when using
|
||||
* their {@code toString} method.
|
||||
* <p>
|
||||
* Here's an example: Lets say that you have a {@link Vec2f} and to convert it
|
||||
* to a String, which you can do with {@link Vec2f#toString()}. With this flag disabled
|
||||
* it would return {@code de.staropensource.sosengine.base.types.vectors.Vec2(x=64 y=64)},
|
||||
* with it however it would be {@code Vec2(x=64 y=64)}, which is much smaller.
|
||||
* Here's an example: Lets say that you
|
||||
* have a {@link Vec2f} and to convert it
|
||||
* to a String, which you can do with
|
||||
* {@link Vec2f#toString()}. With this flag
|
||||
* disabled it would return
|
||||
* {@code de.staropensource.sosengine.base.types.vectors.}{@link Vec2i}{@code (x=64 y=64)},
|
||||
* with it however it would just return
|
||||
* {@link Vec2i}{@code (x=64 y=64)},
|
||||
* which is much smaller.
|
||||
*
|
||||
* @since v1-alpha2
|
||||
* -- GETTER --
|
||||
|
|
|
|||
|
|
@ -19,8 +19,6 @@
|
|||
|
||||
/**
|
||||
* Interfaces and abstract classes which can be used for implementing classes.
|
||||
* <p>
|
||||
* These are not to be confused with data types. See {@link de.staropensource.sosengine.base.type}.
|
||||
*
|
||||
* @since v1-alpha0
|
||||
*/
|
||||
|
|
|
|||
Loading…
Reference in a new issue