- * 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. *
* 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 the standard output - * instead of the standard error for logging {@code ERROR} and {@code CRASH}. + * If enabled, will force the {@link Logger} and {@link CrashHandler} to use + * the standard output + * instead of the standard error + * 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. *
- * 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 -- diff --git a/base/src/main/java/de/staropensource/sosengine/base/implementable/package-info.java b/base/src/main/java/de/staropensource/sosengine/base/implementable/package-info.java index 49b8710df..9273a5b54 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/implementable/package-info.java +++ b/base/src/main/java/de/staropensource/sosengine/base/implementable/package-info.java @@ -19,8 +19,6 @@ /** * Interfaces and abstract classes which can be used for implementing classes. - *
- * These are not to be confused with data types. See {@link de.staropensource.sosengine.base.type}. * * @since v1-alpha0 */