From 540afe813997d9373e716f7208e3c255997eefac Mon Sep 17 00:00:00 2001 From: JeremyStarTM Date: Tue, 24 Dec 2024 03:19:52 +0100 Subject: [PATCH] Remove KDoc annoyances --- .../engine/base/implementation/logging/package-info.kt | 4 +--- .../engine/base/implementation/stream/NullFileStream.kt | 2 +- .../kotlin/de/staropensource/engine/base/logging/Processor.kt | 4 ++-- .../engine/base/type/logging/ChannelSettings.kt | 2 +- 4 files changed, 5 insertions(+), 7 deletions(-) diff --git a/base/src/main/kotlin/de/staropensource/engine/base/implementation/logging/package-info.kt b/base/src/main/kotlin/de/staropensource/engine/base/implementation/logging/package-info.kt index 1cc5276..c7119de 100644 --- a/base/src/main/kotlin/de/staropensource/engine/base/implementation/logging/package-info.kt +++ b/base/src/main/kotlin/de/staropensource/engine/base/implementation/logging/package-info.kt @@ -19,9 +19,7 @@ /** * Implementations of various - * interfaces and abstract classes - * found in the [de.staropensource.engine.base.implementable.logging] - * package of the logging system. + * interfaces and abstract classes. * * @since v1-alpha10 */ diff --git a/base/src/main/kotlin/de/staropensource/engine/base/implementation/stream/NullFileStream.kt b/base/src/main/kotlin/de/staropensource/engine/base/implementation/stream/NullFileStream.kt index 0575413..742d35d 100644 --- a/base/src/main/kotlin/de/staropensource/engine/base/implementation/stream/NullFileStream.kt +++ b/base/src/main/kotlin/de/staropensource/engine/base/implementation/stream/NullFileStream.kt @@ -22,7 +22,7 @@ package de.staropensource.engine.base.implementation.stream import de.staropensource.engine.base.implementable.stream.FileStream /** - * A [de.staropensource.engine.base.implementable.stream.FileStream] which does nothing. + * A [FileStream] which does nothing. * * @since v1-alpha10 */ diff --git a/base/src/main/kotlin/de/staropensource/engine/base/logging/Processor.kt b/base/src/main/kotlin/de/staropensource/engine/base/logging/Processor.kt index 02cc2c8..a679939 100644 --- a/base/src/main/kotlin/de/staropensource/engine/base/logging/Processor.kt +++ b/base/src/main/kotlin/de/staropensource/engine/base/logging/Processor.kt @@ -77,8 +77,8 @@ class Processor private constructor() { * following steps: * 1. build the log format * 2. update message - * 3. format the finalized format using the configured [de.staropensource.engine.logging.implementable.Formatter] - * 4. pass the finalized format to the configured [de.staropensource.engine.logging.implementable.Adapter]. + * 3. format the finalized format using the configured [Formatter] + * 4. pass the finalized format to the configured [Adapter]. * * Invoked by the configured * [LoggerThreadingHandler]. diff --git 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 index 7004694..e75ec02 100644 --- 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 @@ -63,7 +63,7 @@ data class ChannelSettings( * in the global configuration will * affect all channels which have not * been configured in - * [de.staropensource.engine.logging.LoggerConfiguration.channelSettings]. + * [EngineConfiguration.logChannelSettings]. * * @since v1-alpha10 */