doc: added comments to explain why unused inspection is suppressed

TelenorNorway · Apr 1, 2024 · 54e991d · 54e991d
1 parent 07704e6
commit 54e991d
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 0 deletions.
diff --git a/projects/logging/logging-model/src/main/kotlin/io/tnboot/logging/model/Error.kt b/projects/logging/logging-model/src/main/kotlin/io/tnboot/logging/model/Error.kt
@@ -3,6 +3,10 @@ package io.tnboot.logging.model
 /**
  * Represents an error.
  */
+// Properties are marked as unused by IntelliJ because they are not
+// used in the project. However, they are used by consumers of the
+// module.
+@Suppress("unused")
 interface Error {
 	val className: String
 	val message: String?

diff --git a/projects/logging/logging-model/src/main/kotlin/io/tnboot/logging/model/LogPayload.kt b/projects/logging/logging-model/src/main/kotlin/io/tnboot/logging/model/LogPayload.kt
@@ -7,6 +7,10 @@ import java.time.Instant
  * event. This is the data that is passed to Telenor Boot Logging
  * themes when a log event is created.
  */
+// Properties are marked as unused by IntelliJ because they are not
+// used in the project. However, they are used by consumers of the
+// module.
+@Suppress("unused")
 interface LogPayload {
 	val at: Instant
 	val level: LogLevel

diff --git a/projects/logging/logging-model/src/main/kotlin/io/tnboot/logging/model/StackTraceElement.kt b/projects/logging/logging-model/src/main/kotlin/io/tnboot/logging/model/StackTraceElement.kt
@@ -3,6 +3,10 @@ package io.tnboot.logging.model
 /**
  * Represents a single element in a stack trace.
  */
+// Properties are marked as unused by IntelliJ because they are not
+// used in the project. However, they are used by consumers of the
+// module.
+@Suppress("unused")
 interface StackTraceElement {
 	val classLoaderName: String?
 	val clazz: String

diff --git a/projects/logging/logging-model/src/main/kotlin/io/tnboot/logging/model/Theme.kt b/projects/logging/logging-model/src/main/kotlin/io/tnboot/logging/model/Theme.kt
@@ -5,6 +5,9 @@ package io.tnboot.logging.model
  * Logging. A theme is responsible for rendering a log event into a
  * string that can be written to a log file or console.
  */
+// Methods are marked as unused by IntelliJ because they are not used
+// in the project. However, they are used by consumers of the module.
+@Suppress("unused")
 interface Theme {
 	/**
 	 * The name of the theme.