Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: added comments to explain why unused inspection is suppressed #26

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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?
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down