detekt-api/io.gitlab.arturbosch.detekt.api/CodeSmell

CodeSmell

open class CodeSmell(val entity: Entity, val message: String, val references: List<Entity> = emptyList()) : Finding

A code smell indicates any possible design problem inside a program's source code. The type of a code smell is described by an Issue.

If the design problem manifests by different source locations, references to these locations can be stored in additional Entity's.

Inheritors

CorrectableCodeSmell

Constructors

constructor(entity: Entity, message: String, references: List<Entity> = emptyList())

Properties

override val entity: Entity

override val message: String

override val references: List<Entity>

Functions

open override fun toString(): String