Add constructor API documentation

2024-12-28 00:50:23 +01:00 · 2024-12-28 00:50:23 +01:00 · df3ef9829e
commit df3ef9829e
parent c3223f0add
60 changed files with 80 additions and 2 deletions
--- a/ansi/src/main/kotlin/de/staropensource/engine/ansi/AnsiFormatter.kt
+++ b/ansi/src/main/kotlin/de/staropensource/engine/ansi/AnsiFormatter.kt
@ -26,6 +26,7 @@ import de.staropensource.engine.base.implementable.formatter.TwoCycleFormatterIm
 * Formats a string using ANSI
 * escape sequences.
 *
+ * @constructor Initializes this formatter
 * @since v1-alpha10
 */
 class AnsiFormatter : TwoCycleFormatterImpl() {
--- a/ansi/src/main/kotlin/de/staropensource/engine/ansi/AnsiSubsystem.kt
+++ b/ansi/src/main/kotlin/de/staropensource/engine/ansi/AnsiSubsystem.kt
@ -28,6 +28,7 @@ import de.staropensource.engine.base.utility.dnihbd.BuildInformation
 /**
 * The ANSI subsystem.
 *
+ * @constructor Initializes this subsystem
 * @since v1-alpha10
 */
 class AnsiSubsystem : Subsystem() {
--- a/base/src/main/kotlin/de/staropensource/engine/base/Engine.kt
+++ b/base/src/main/kotlin/de/staropensource/engine/base/Engine.kt
@ -35,6 +35,7 @@ import kotlin.reflect.KClass
 * This class is responsible for starting
 * and shutting the engine up or down.
 *
+ * @constructor Initializes this class
 * @since v1-alpha10
 */
 class Engine private constructor() {
--- a/base/src/main/kotlin/de/staropensource/engine/base/EngineConfiguration.kt
+++ b/base/src/main/kotlin/de/staropensource/engine/base/EngineConfiguration.kt
@ -40,6 +40,7 @@ import kotlin.reflect.KClass
 /**
 * Provides the engine configuration.
 *
+ * @constructor Initializes this class
 * @since v1-alpha10
 */
 class EngineConfiguration private constructor() {
--- a/base/src/main/kotlin/de/staropensource/engine/base/exception/EngineInitializationFailureException.kt
+++ b/base/src/main/kotlin/de/staropensource/engine/base/exception/EngineInitializationFailureException.kt
@ -26,6 +26,8 @@ package de.staropensource.engine.base.exception
 * After this occurs, it will no longer
 * be possible to initialize the engine.
 *
+ * @constructor Initializes this exception
+ * @param throwable [Throwable] which caused the initialization to fail
 * @since v1-alpha10
 */
 class EngineInitializationFailureException(val throwable: Throwable) : RuntimeException("The StarOpenSource Engine failed to initialize", throwable)
--- a/base/src/main/kotlin/de/staropensource/engine/base/exception/VerificationFailedException.kt
+++ b/base/src/main/kotlin/de/staropensource/engine/base/exception/VerificationFailedException.kt
@ -22,6 +22,9 @@ package de.staropensource.engine.base.exception
 /**
 * Thrown when a verification fails.
 *
+ * @constructor Initializes this exception
+ * @param error     error
+ * @param throwable [Throwable] which caused the verification to fail
 * @since v1-alpha10
 */
 class VerificationFailedException(val error: String? = null, val throwable: Throwable? = null) : RuntimeException(error, throwable)
--- a/base/src/main/kotlin/de/staropensource/engine/base/exception/io/FileOrDirectoryNotFoundException.kt
+++ b/base/src/main/kotlin/de/staropensource/engine/base/exception/io/FileOrDirectoryNotFoundException.kt
@ -23,6 +23,9 @@ package de.staropensource.engine.base.exception.io
 * Thrown when being unable to
 * find a file or directory.
 *
+ * @constructor Initializes this exception
+ * @param path      path which does not exist
+ * @param throwable [Throwable] which caused the file or directory to not be found
 * @since v1-alpha10
 */
 class FileOrDirectoryNotFoundException(val path: String, val throwable: Throwable? = null) : Exception("The file or directory '${path}' could not be found", throwable)
--- a/base/src/main/kotlin/de/staropensource/engine/base/exception/io/FileTooLargeException.kt
+++ b/base/src/main/kotlin/de/staropensource/engine/base/exception/io/FileTooLargeException.kt
@ -24,6 +24,9 @@ package de.staropensource.engine.base.exception.io
 * fails due to it being larger
 * than the heap.
 *
+ * @constructor Initializes this exception
+ * @param path      path of the file which is too large
+ * @param throwable [Throwable] which caused the file read to fail
 * @since v1-alpha10
 */
 class FileTooLargeException(val path: String, val throwable: Throwable? = null) : RuntimeException("Unable to read file '${path}' as it is larger than the configured heap size", throwable)
--- a/base/src/main/kotlin/de/staropensource/engine/base/exception/io/IOAccessException.kt
+++ b/base/src/main/kotlin/de/staropensource/engine/base/exception/io/IOAccessException.kt
@ -23,6 +23,9 @@ package de.staropensource.engine.base.exception.io
 * Thrown when a general
 * IO error occurs.
 *
+ * @constructor Initializes this exception
+ * @param error     error
+ * @param throwable [Throwable] which caused this IO error
 * @since v1-alpha10
 */
 class IOAccessException(val error: String? = null, val throwable: Throwable? = null) : RuntimeException(error, throwable)
--- a/base/src/main/kotlin/de/staropensource/engine/base/exception/io/StreamClosedException.kt
+++ b/base/src/main/kotlin/de/staropensource/engine/base/exception/io/StreamClosedException.kt
@ -25,6 +25,8 @@ import de.staropensource.engine.base.implementable.stream.Stream
 * Thrown when trying to
 * access a closed [Stream].
 *
+ * @constructor Initializes this exception
+ * @param stream stream which was accessed
 * @see Stream
 * @see Stream.closed
 * @since v1-alpha10
--- a/base/src/main/kotlin/de/staropensource/engine/base/implementable/Subsystem.kt
+++ b/base/src/main/kotlin/de/staropensource/engine/base/implementable/Subsystem.kt
@ -22,6 +22,7 @@ package de.staropensource.engine.base.implementable
 /**
 * Provides an API for the engine to talk to subsystems.
 *
+ * @constructor Initializes this subsystem
 * @since v1-alpha10
 */
 abstract class Subsystem {
--- a/base/src/main/kotlin/de/staropensource/engine/base/implementable/formatter/Formatter.kt
+++ b/base/src/main/kotlin/de/staropensource/engine/base/implementable/formatter/Formatter.kt
@ -48,6 +48,7 @@ package de.staropensource.engine.base.implementable.formatter
 * If an invalid tag is found it must be
 * simply ignored.
 *
+ * @constructor Initializes this formatter
 * @since v1-alpha10
 */
 abstract class Formatter {
--- a/base/src/main/kotlin/de/staropensource/engine/base/implementable/formatter/OneCycleFormatter.kt
+++ b/base/src/main/kotlin/de/staropensource/engine/base/implementable/formatter/OneCycleFormatter.kt
@ -31,6 +31,7 @@ package de.staropensource.engine.base.implementable.formatter
 * unnecessary resource and memory usage for
 * certain formatters.
 *
+ * @constructor Initializes this formatter
 * @see Formatter
 * @since v1-alpha10
 */
--- a/base/src/main/kotlin/de/staropensource/engine/base/implementable/formatter/TwoCycleFormatter.kt
+++ b/base/src/main/kotlin/de/staropensource/engine/base/implementable/formatter/TwoCycleFormatter.kt
@ -31,6 +31,7 @@ package de.staropensource.engine.base.implementable.formatter
 * unnecessary resource and memory usage for
 * certain formatters.
 *
+ * @constructor Initializes this formatter
 * @see Formatter
 * @since v1-alpha10
 */
--- a/base/src/main/kotlin/de/staropensource/engine/base/implementable/formatter/TwoCycleFormatterImpl.kt
+++ b/base/src/main/kotlin/de/staropensource/engine/base/implementable/formatter/TwoCycleFormatterImpl.kt
@ -38,6 +38,7 @@ import kotlin.text.iterator
 * - `COLOR:` (example `COLOR:RED`)
 * - `ATTRIBUTE:` (example `ATTRIBUTE:BOLD`)
 *
+ * @constructor Initializes this formatter
 * @see TwoCycleFormatter
 * @see Formatter
 * @since v1-alpha10
--- a/base/src/main/kotlin/de/staropensource/engine/base/implementable/logging/FormatBuilder.kt
+++ b/base/src/main/kotlin/de/staropensource/engine/base/implementable/logging/FormatBuilder.kt
@ -26,6 +26,7 @@ import de.staropensource.engine.base.type.logging.Feature
 /**
 * Builds log formats.
 *
+ * @constructor Initializes this format builder
 * @param call            [Call] to build a format for
 * @param channelSettings appropriate [ChannelSettings] instance
 * @since v1-alpha10
--- a/base/src/main/kotlin/de/staropensource/engine/base/implementable/stream/ReadStream.kt
+++ b/base/src/main/kotlin/de/staropensource/engine/base/implementable/stream/ReadStream.kt
@ -22,6 +22,7 @@ package de.staropensource.engine.base.implementable.stream
 /**
 * A read-only [Stream].
 *
+ * @constructor Initializes this stream
 * @since v1-alpha10
 */
 abstract class ReadStream : Stream(
--- a/base/src/main/kotlin/de/staropensource/engine/base/implementable/stream/Stream.kt
+++ b/base/src/main/kotlin/de/staropensource/engine/base/implementable/stream/Stream.kt
@ -31,6 +31,7 @@ import java.io.OutputStream
 /**
 * Makes streaming data easy.
 *
+ * @constructor Initializes this stream
 * @param streamMode supported [StreamMode]s
 * @param autoFlushAfter after which amount of bytes to automatically flush. May be ignored by some implementations. Implementations should expose this argument in their constructor
 * @since v1-alpha10
@ -706,6 +707,7 @@ abstract class Stream(
     * An implementation of Java
     * [InputStream]s for [Stream]s.
     *
+     * @constructor Initializes this stream
     * @param stream [Stream] to use
     * @throws IOException on IO error
     * @since v1-alpha10
@ -733,6 +735,7 @@ abstract class Stream(
     * An implementation of Java
     * [OutputStream]s for [Stream]s.
     *
+     * @constructor Initializes this stream
     * @param stream [Stream] to use
     * @since v1-alpha10
     */
--- a/base/src/main/kotlin/de/staropensource/engine/base/implementable/stream/WriteStream.kt
+++ b/base/src/main/kotlin/de/staropensource/engine/base/implementable/stream/WriteStream.kt
@ -22,6 +22,7 @@ package de.staropensource.engine.base.implementable.stream
 /**
 * A write-only [Stream].
 *
+ * @constructor Initializes this stream
 * @param autoFlushAfter after which amount of bytes to automatically flush. May be ignored by some implementations. Implementations should expose this argument in their constructor
 * @since v1-alpha10
 */
--- a/base/src/main/kotlin/de/staropensource/engine/base/implementation/logging/KotlinShutdownHandler.kt
+++ b/base/src/main/kotlin/de/staropensource/engine/base/implementation/logging/KotlinShutdownHandler.kt
@ -26,6 +26,7 @@ import kotlin.system.exitProcess
 * [ShutdownHandler] implementation using
 * Kotlin's [exitProcess] method.
 *
+ * @constructor Initializes this shutdown handler
 * @since v1-alpha10
 */
 class KotlinShutdownHandler private constructor() : ShutdownHandler {
--- a/base/src/main/kotlin/de/staropensource/engine/base/implementation/logging/NoOperationFormatter.kt
+++ b/base/src/main/kotlin/de/staropensource/engine/base/implementation/logging/NoOperationFormatter.kt
@ -27,6 +27,7 @@ import kotlin.text.iterator
 * Swallows all formatting tags
 * and returns a clean format.
 *
+ * @constructor Initializes this formatter
 * @see Formatter
 * @since v1-alpha10
 */
--- a/base/src/main/kotlin/de/staropensource/engine/base/implementation/logging/adapter/FileWriteAdapter.kt
+++ b/base/src/main/kotlin/de/staropensource/engine/base/implementation/logging/adapter/FileWriteAdapter.kt
@ -27,6 +27,8 @@ import de.staropensource.engine.base.utility.FileAccess
 * [Adapter] for writing log
 * output to the specific file.
 *
+ * @constructor Initializes this adapter
+ * @param location file to write log output to
 * @see Adapter
 * @since v1-alpha10
 */
--- a/base/src/main/kotlin/de/staropensource/engine/base/implementation/logging/adapter/PrintlnAdapter.kt
+++ b/base/src/main/kotlin/de/staropensource/engine/base/implementation/logging/adapter/PrintlnAdapter.kt
@ -26,6 +26,7 @@ import de.staropensource.engine.base.type.logging.Call
 * [Adapter] for printing messages
 * using Kotlin's [println] method.
 *
+ * @constructor Initializes this adapter
 * @see Adapter
 * @since v1-alpha10
 */
--- a/base/src/main/kotlin/de/staropensource/engine/base/implementation/logging/crashcategory/EngineCrashCategory.kt
+++ b/base/src/main/kotlin/de/staropensource/engine/base/implementation/logging/crashcategory/EngineCrashCategory.kt
@ -26,6 +26,7 @@ import de.staropensource.engine.base.utility.dnihbd.BuildInformation
 * [CrashCategory] implementation
 * providing information about the engine.
 *
+ * @constructor Initializes this crash category
 * @since v1-alpha10
 */
 class EngineCrashCategory private constructor() : BuildInformation.BuildInformationCrashCategory() {
--- a/base/src/main/kotlin/de/staropensource/engine/base/implementation/logging/crashcategory/EnvironmentCrashCategory.kt
+++ b/base/src/main/kotlin/de/staropensource/engine/base/implementation/logging/crashcategory/EnvironmentCrashCategory.kt
@ -32,6 +32,7 @@ import kotlinx.datetime.toLocalDateTime
 * providing information about the
 * environment the engine runs in.
 *
+ * @constructor Initializes this crash category
 * @since v1-alpha10
 */
 class EnvironmentCrashCategory private constructor() : CrashCategory {
--- a/base/src/main/kotlin/de/staropensource/engine/base/implementation/logging/crashcategory/InfoCrashCategory.kt
+++ b/base/src/main/kotlin/de/staropensource/engine/base/implementation/logging/crashcategory/InfoCrashCategory.kt
@ -28,6 +28,7 @@ import de.staropensource.engine.base.utility.misc.StackTraceUtils
 * [CrashCategory] implementation
 * providing insight into a crash.
 *
+ * @constructor Initializes this crash category
 * @since v1-alpha10
 */
 class InfoCrashCategory private constructor() : CrashCategory {
--- a/base/src/main/kotlin/de/staropensource/engine/base/implementation/logging/formatbuilder/SOSLSv2FormatBuilder.kt
+++ b/base/src/main/kotlin/de/staropensource/engine/base/implementation/logging/formatbuilder/SOSLSv2FormatBuilder.kt
@ -41,6 +41,7 @@ import kotlin.time.Duration
 * [505ms] [03.10.1990 23:23:23] [INFO de.staropensource.engine.testapp.Main#sayHi~42] Hello World!
 * ```
 *
+ * @constructor Initializes this format builder
 * @param call            [Call] to build a format for
 * @param channelSettings appropriate [ChannelSettings] instance
 * @since v1-alpha10
--- a/base/src/main/kotlin/de/staropensource/engine/base/implementation/stream/ByteReadStream.kt
+++ b/base/src/main/kotlin/de/staropensource/engine/base/implementation/stream/ByteReadStream.kt
@ -28,6 +28,7 @@ import java.io.ByteArrayInputStream
 * A [Stream] which can
 * only read [Byte]s.
 *
+ * @constructor Initializes this stream
 * @param bytesRead [ByteArray] to provide for reading
 * @since v1-alpha10
 */
--- a/base/src/main/kotlin/de/staropensource/engine/base/implementation/stream/ByteStream.kt
+++ b/base/src/main/kotlin/de/staropensource/engine/base/implementation/stream/ByteStream.kt
@ -27,6 +27,7 @@ import java.io.ByteArrayInputStream
 * A [Stream] which can
 * read and write [Byte]s.
 *
+ * @constructor Initializes this stream
 * @param bytesRead [ByteArray] to provide for reading
 * @since v1-alpha10
 */
--- a/base/src/main/kotlin/de/staropensource/engine/base/implementation/stream/ByteWriteStream.kt
+++ b/base/src/main/kotlin/de/staropensource/engine/base/implementation/stream/ByteWriteStream.kt
@ -27,6 +27,7 @@ import de.staropensource.engine.base.implementable.stream.WriteStream
 * A [Stream] which can
 * only write [Byte]s.
 *
+ * @constructor Initializes this stream
 * @since v1-alpha10
 */
 open class ByteWriteStream : WriteStream(
--- a/base/src/main/kotlin/de/staropensource/engine/base/implementation/stream/FileAccessStream.kt
+++ b/base/src/main/kotlin/de/staropensource/engine/base/implementation/stream/FileAccessStream.kt
@ -31,6 +31,7 @@ import java.io.InputStream
 * accessing files via the [FileAccess]
 * API.
 *
+ * @constructor Initializes this stream
 * @param file [FileAccess] to use
 * @see FileAccess.toStream
 * @since v1-alpha10
--- a/base/src/main/kotlin/de/staropensource/engine/base/implementation/stream/JavaReadStream.kt
+++ b/base/src/main/kotlin/de/staropensource/engine/base/implementation/stream/JavaReadStream.kt
@ -30,6 +30,7 @@ import java.io.InputStream
 * it's calls instances of Java's
 * [InputStream] class.
 *
+ * @constructor Initializes this stream
 * @param inputStream          Java's [InputStream] to read from
 * @param autoCloseJavaStream if to automatically close the supplied [InputStream] if [close] is invoked
 * @since v1-alpha10
--- a/base/src/main/kotlin/de/staropensource/engine/base/implementation/stream/JavaStream.kt
+++ b/base/src/main/kotlin/de/staropensource/engine/base/implementation/stream/JavaStream.kt
@ -31,6 +31,7 @@ import java.io.OutputStream
 * [InputStream] and [OutputStream]
 * classes.
 *
+ * @constructor Initializes this stream
 * @param inputStream          Java's [InputStream] to read from
 * @param outputStream         Java's [OutputStream] to write to
 * @param autoCloseJavaStreams if to automatically close the supplied [InputStream] and [OutputStream] if [close] is invoked
--- a/base/src/main/kotlin/de/staropensource/engine/base/implementation/stream/JavaWriteStream.kt
+++ b/base/src/main/kotlin/de/staropensource/engine/base/implementation/stream/JavaWriteStream.kt
@ -30,6 +30,7 @@ import java.io.OutputStream
 * it's calls instances of Java's
 * [OutputStream] class.
 *
+ * @constructor Initializes this stream
 * @param outputStream          Java's [OutputStream] to write to
 * @param autoCloseJavaStream if to automatically close the supplied [OutputStream] if [close] is invoked
 * @param autoFlushAfter after which amount of bytes to automatically flush. May be ignored by some implementations. Implementations should expose this argument in their constructor
--- a/base/src/main/kotlin/de/staropensource/engine/base/implementation/stream/LoggerStream.kt
+++ b/base/src/main/kotlin/de/staropensource/engine/base/implementation/stream/LoggerStream.kt
@ -32,6 +32,7 @@ import de.staropensource.engine.base.utility.FileAccess
 * A log message is only printed
 * after a newline (`\n`) is written.
 *
+ * @constructor Initializes this stream
 * @param logger [Logger] instance to use
 * @see FileAccess.toStream
 * @since v1-alpha10
--- a/base/src/main/kotlin/de/staropensource/engine/base/implementation/stream/NullStream.kt
+++ b/base/src/main/kotlin/de/staropensource/engine/base/implementation/stream/NullStream.kt
@ -25,6 +25,7 @@ import de.staropensource.engine.base.implementable.stream.Stream
 * A [Stream] which does nothing
 * and cannot even be closed.
 *
+ * @constructor Initializes this stream
 * @since v1-alpha10
 */
 class NullStream private constructor() : Stream(streamMode = StreamMode.READ_WRITE) {
--- a/base/src/main/kotlin/de/staropensource/engine/base/implementation/stream/StringReadStream.kt
+++ b/base/src/main/kotlin/de/staropensource/engine/base/implementation/stream/StringReadStream.kt
@ -25,6 +25,7 @@ import de.staropensource.engine.base.implementable.stream.Stream
 * A [Stream] which can
 * only read strings.
 *
+ * @constructor Initializes this stream
 * @param stringRead string to provide for reading
 * @since v1-alpha10
 */
--- a/base/src/main/kotlin/de/staropensource/engine/base/implementation/stream/StringStream.kt
+++ b/base/src/main/kotlin/de/staropensource/engine/base/implementation/stream/StringStream.kt
@ -25,6 +25,7 @@ import de.staropensource.engine.base.implementable.stream.Stream
 * A [Stream] which can
 * read and write strings.
 *
+ * @constructor Initializes this stream
 * @param stringRead string to provide for reading
 * @since v1-alpha10
 */
--- a/base/src/main/kotlin/de/staropensource/engine/base/implementation/stream/StringWriteStream.kt
+++ b/base/src/main/kotlin/de/staropensource/engine/base/implementation/stream/StringWriteStream.kt
@ -25,6 +25,7 @@ import de.staropensource.engine.base.implementable.stream.Stream
 * A [Stream] which can
 * only write strings.
 *
+ * @constructor Initializes this stream
 * @since v1-alpha10
 */
 open class StringWriteStream : ByteWriteStream() {
--- a/base/src/main/kotlin/de/staropensource/engine/base/logging/CrashHandler.kt
+++ b/base/src/main/kotlin/de/staropensource/engine/base/logging/CrashHandler.kt
@ -30,6 +30,7 @@ import de.staropensource.engine.base.type.logging.ChannelSettings
 /**
 * Handles crashes.
 *
+ * @constructor Initializes this class
 * @since v1-alpha10
 */
 class CrashHandler private constructor() {
--- a/base/src/main/kotlin/de/staropensource/engine/base/logging/Filterer.kt
+++ b/base/src/main/kotlin/de/staropensource/engine/base/logging/Filterer.kt
@ -25,6 +25,7 @@ import de.staropensource.engine.base.type.logging.Call
 /**
 * Handles call filtering.
 *
+ * @constructor Initializes this class
 * @since v1-alpha10
 */
 class Filterer private constructor() {
--- a/base/src/main/kotlin/de/staropensource/engine/base/logging/Logger.kt
+++ b/base/src/main/kotlin/de/staropensource/engine/base/logging/Logger.kt
@ -39,6 +39,7 @@ import kotlinx.datetime.Instant
 * with internal classes while leaving the
 * unimportant bits out.
 *
+ * @constructor Initializes this class
 * @since v1-alpha10
 */
 class Logger {
--- a/base/src/main/kotlin/de/staropensource/engine/base/logging/Processor.kt
+++ b/base/src/main/kotlin/de/staropensource/engine/base/logging/Processor.kt
@ -37,6 +37,7 @@ import kotlin.reflect.full.primaryConstructor
 * This class will parse, process,
 * reformat and finally print log messages.
 *
+ * @constructor Initializes this class
 * @since v1-alpha10
 */
 class Processor private constructor() {
--- a/base/src/main/kotlin/de/staropensource/engine/base/type/Origin.kt
+++ b/base/src/main/kotlin/de/staropensource/engine/base/type/Origin.kt
@ -24,6 +24,7 @@ import de.staropensource.engine.base.EngineConfiguration
 /**
 * Holds data about a method caller.
 *
+ * @constructor Initializes this class
 * @param packageName fully qualified name of the package where the calling class is in
 * @param className   name of the calling class
 * @param methodName  name of the calling method
--- a/base/src/main/kotlin/de/staropensource/engine/base/type/logging/Call.kt
+++ b/base/src/main/kotlin/de/staropensource/engine/base/type/logging/Call.kt
@ -25,6 +25,7 @@ import de.staropensource.engine.base.type.Origin
 /**
 * Holds information about log calls.
 *
+ * @constructor Initializes this class
 * @param origin  caller origin
 * @param level   level
 * @param message message
--- a/base/src/main/kotlin/de/staropensource/engine/base/type/logging/ChannelSettings.kt
+++ b/base/src/main/kotlin/de/staropensource/engine/base/type/logging/ChannelSettings.kt
@ -29,12 +29,13 @@ import de.staropensource.engine.base.implementation.logging.adapter.PrintlnAdapt
 * Holds the configuration of one
 * or multiple log channels.
 *
+ * @constructor Initializes this class
 * @param enable           enables or disables all log messages utilising this channel. Defaults to the global value or `true` if set to `null`
 * @param sanitizeMessage  if message sanitization (escaping `<`) should be performed. Defaults to the global value or `true` if set to `null`
 * @param permitFormatting if formatting shall be permitted for the entire format. For disallowing formatting for the message only, see [sanitizeMessage]. Defaults to the global value or `true` if set to `null`
 * @param applicationName  name of the application. Used in crash reports. Defaults to the global value or `"This application"` if `null`
 * @param formatter        determines how messages are formatted and stylized. Defaults to the global value or [NoOperationFormatter] if set to `null`
- * @param adapter          used for printing the finalized log format somewhere. Defaults to the global value [PrintlnAdapter] if set to `null`
+ * @param adapters         used for printing the finalized log format somewhere. Defaults to the global value [PrintlnAdapter] if set to `null`
 * @since v1-alpha10
 */
 data class ChannelSettings(
--- a/base/src/main/kotlin/de/staropensource/engine/base/type/versioning/VersionType.kt
+++ b/base/src/main/kotlin/de/staropensource/engine/base/type/versioning/VersionType.kt
@ -24,9 +24,10 @@ package de.staropensource.engine.base.type.versioning
 * [SOSVS](z.staropensource.de/spec-versioning)
 * specifications.
 *
+ * @constructor Initializes this class
 * @since v1-alpha10
 */
-class VersionType {
+class VersionType private constructor() {
    /**
     * Represents the version types
     * found in the [second iteration](z.staropensource.de/spec-versioning-v2)
--- a/base/src/main/kotlin/de/staropensource/engine/base/utility/DataSize.kt
+++ b/base/src/main/kotlin/de/staropensource/engine/base/utility/DataSize.kt
@ -27,6 +27,7 @@ import java.util.Locale
 /**
 * Converts between various data size units.
 *
+ * @constructor Initializes this class
 * @param bytes bytes to convert
 * @since v1-alpha10
 */
--- a/base/src/main/kotlin/de/staropensource/engine/base/utility/Environment.kt
+++ b/base/src/main/kotlin/de/staropensource/engine/base/utility/Environment.kt
@ -31,6 +31,7 @@ import oshi.hardware.HardwareAbstractionLayer
 * Provides information about the
 * environment the application runs in.
 *
+ * @constructor Initializes this class
 * @since v1-alpha10
 */
@Suppress("Unused")
@ -456,6 +457,7 @@ class Environment private constructor() {
    /**
     * Represents a graphics card.
     *
+     * @constructor Initializes this class
     * @since v1-alpha10
     */
    class GraphicsCard internal constructor(val graphicsCard: oshi.hardware.GraphicsCard) {
--- a/base/src/main/kotlin/de/staropensource/engine/base/utility/FileAccess.kt
+++ b/base/src/main/kotlin/de/staropensource/engine/base/utility/FileAccess.kt
@ -41,6 +41,7 @@ import java.nio.file.attribute.PosixFilePermissions
 * Provides a simplified way of
 * accessing files and directories.
 *
+ * @constructor Initializes this class
 * @since v1-alpha10
 */
@Suppress("Unused")
@ -1472,6 +1473,7 @@ class FileAccess {
     * {@link FileVisitor} instance for
     * copying directories recursively.
     *
+     * @constructor Initializes this class
     * @param source      source to copy from
     * @param destination destination to copy to
     * @since v1-alpha9
@ -1503,6 +1505,7 @@ class FileAccess {
     * {@link FileVisitor} instance for
     * delete directories recursively.
     *
+     * @constructor Initializes this class
     * @since v1-alpha9
     */
    private class DeleteDirectoryVisitor : FileVisitor<Path> {
--- a/base/src/main/kotlin/de/staropensource/engine/base/utility/Process.kt
+++ b/base/src/main/kotlin/de/staropensource/engine/base/utility/Process.kt
@ -358,6 +358,7 @@ class Process {
     * Used for the [standardInput]
     * stream of a [Process].
     *
+     * @constructor Initializes this stream
     * @since v1-alpha10
     */
    private class StandardInputStream(
@ -395,6 +396,7 @@ class Process {
     * and [standardError] streams
     * of a [Process].
     *
+     * @constructor Initializes this stream
     * @since v1-alpha10
     */
    private class StandardOutputErrorStream(
--- a/base/src/main/kotlin/de/staropensource/engine/base/utility/dnihbd/BuildInformation.kt
+++ b/base/src/main/kotlin/de/staropensource/engine/base/utility/dnihbd/BuildInformation.kt
@ -47,6 +47,7 @@ import java.util.*
 * `help what does this do i don't
 * understand :neofox_woozy:` disease.
 *
+ * @constructor Initializes this class
 * @param loadPrefix   prefix used for accessing the files
 * @param loadLocation location used for accessing the files. Set to `null` to use the JAR's bundled resources.
 * @since v1-alpha10
@ -430,6 +431,7 @@ open class BuildInformation
     * A [CrashCategory] implementation providing
     * details about your running build.
     *
+     * @constructor Initializes this crash category
     * @since v1-alpha10
     */
    abstract class BuildInformationCrashCategory : CrashCategory {
--- a/base/src/main/kotlin/de/staropensource/engine/base/utility/misc/Miscellaneous.kt
+++ b/base/src/main/kotlin/de/staropensource/engine/base/utility/misc/Miscellaneous.kt
@ -22,6 +22,7 @@ package de.staropensource.engine.base.utility.misc
 /**
 * REALLY miscellaneous methods are in here.
 *
+ * @constructor Initializes this class
 * @since v1-alpha10
 */
 class Miscellaneous private constructor() {
--- a/base/src/main/kotlin/de/staropensource/engine/base/utility/misc/StackTraceUtils.kt
+++ b/base/src/main/kotlin/de/staropensource/engine/base/utility/misc/StackTraceUtils.kt
@ -26,6 +26,7 @@ import java.lang.reflect.InvocationTargetException
 * Utility methods for stack trace
 * and exception analysis.
 *
+ * @constructor Initializes this class
 * @since v1-alpha10
 */
 class StackTraceUtils private constructor() {
--- a/base/src/test/kotlin/de/staropensource/engine/base/TestBase.kt
+++ b/base/src/test/kotlin/de/staropensource/engine/base/TestBase.kt
@ -28,6 +28,7 @@ import de.staropensource.engine.testing.TestBase
 * This class sets some nice defaults
 * and adds other things only useful to us.
 *
+ * @constructor Initializes this class
 * @param autoManage           automatically initializes and shuts the engine down after each test
 * @param logLevels            contains the allowed log levels
 * @param shutdownMarksFailure whether engine shutdowns should mark the test as failed
--- a/dist/template-subproject/src/main/kotlin/de/staropensource/engine/newsubprj/Example.kt
+++ b/dist/template-subproject/src/main/kotlin/de/staropensource/engine/newsubprj/Example.kt
@ -23,6 +23,7 @@ package de.staropensource.engine.newsubprj
 /**
 * An example class.
 *
+ * @constructor Initializes this class
 * @since v1-alpha10
 */
 class Example private constructor() {
--- a/testapp/src/main/kotlin/de/staropensource/engine/testapp/Main.kt
+++ b/testapp/src/main/kotlin/de/staropensource/engine/testapp/Main.kt
@ -28,6 +28,7 @@ import de.staropensource.engine.base.type.logging.Level
 /**
 * Testing program for the StarOpenSource Engine.
 *
+ * @constructor Initializes this class
 * @since v1-alpha10
 */
 class Main private constructor() {
--- a/testing/src/main/kotlin/de/staropensource/engine/testing/TestBase.kt
+++ b/testing/src/main/kotlin/de/staropensource/engine/testing/TestBase.kt
@ -37,6 +37,7 @@ import kotlin.jvm.optionals.getOrNull
 /**
 * Base class for implementing tests.
 *
+ * @constructor Initializes this class
 * @param autoManage                     automatically initializes and shuts the engine down after each test
 * @param suppressInitAndShutdownLogging if to suppress the engine's log output during engine initialization and shutdown. Only takes effect if [autoManage] is `true`
 * @param logLevels                      contains the allowed log levels
--- a/testing/src/main/kotlin/de/staropensource/engine/testing/implementation/FailureShutdownHandler.kt
+++ b/testing/src/main/kotlin/de/staropensource/engine/testing/implementation/FailureShutdownHandler.kt
@ -26,6 +26,7 @@ import kotlin.test.fail
 * [ShutdownHandler] implementation which
 * causes the test to fail if executed.
 *
+ * @constructor Initializes this shutdown handler
 * @since v1-alpha10
 */
 class FailureShutdownHandler private constructor() : ShutdownHandler {
--- a/testing/src/main/kotlin/de/staropensource/engine/testing/implementation/NoOperationShutdownHandler.kt
+++ b/testing/src/main/kotlin/de/staropensource/engine/testing/implementation/NoOperationShutdownHandler.kt
@ -26,6 +26,7 @@ import kotlin.test.fail
 * [ShutdownHandler] implementation which
 * causes the test to fail if executed.
 *
+ * @constructor Initializes this shutdown handler
 * @since v1-alpha10
 */
 class NoOperationShutdownHandler private constructor() : ShutdownHandler {