diff --git a/docs/pages/kdoc/detekt-api/alltypes/index.md b/docs/pages/kdoc/detekt-api/alltypes/index.md index d940c0464..6cd669e76 100644 --- a/docs/pages/kdoc/detekt-api/alltypes/index.md +++ b/docs/pages/kdoc/detekt-api/alltypes/index.md @@ -14,9 +14,11 @@ title: alltypes - detekt-api | [io.gitlab.arturbosch.detekt.api.ConfigAware](../io.gitlab.arturbosch.detekt.api/-config-aware/index.html) | Interface which is implemented by each Rule class to provide utility functions to retrieve specific or generic properties from the underlying detekt configuration file. | | [io.gitlab.arturbosch.detekt.api.ConsoleReport](../io.gitlab.arturbosch.detekt.api/-console-report/index.html) | Extension point which describes how findings should be printed on the console. | | [io.gitlab.arturbosch.detekt.api.Context](../io.gitlab.arturbosch.detekt.api/-context/index.html) | A context describes the storing and reporting mechanism of [Finding](../io.gitlab.arturbosch.detekt.api/-finding/index.html)'s inside a [Rule](../io.gitlab.arturbosch.detekt.api/-rule/index.html). Additionally it handles suppression and aliases management. | +| [io.gitlab.arturbosch.detekt.api.CorrectableCodeSmell](../io.gitlab.arturbosch.detekt.api/-correctable-code-smell/index.html) | Represents a code smell for that can be auto corrected. | | [io.gitlab.arturbosch.detekt.api.Debt](../io.gitlab.arturbosch.detekt.api/-debt/index.html) | Debt describes the estimated amount of work needed to fix a given issue. | | [io.gitlab.arturbosch.detekt.api.DefaultContext](../io.gitlab.arturbosch.detekt.api/-default-context/index.html) | Default [Context](../io.gitlab.arturbosch.detekt.api/-context/index.html) implementation. | | [io.gitlab.arturbosch.detekt.api.Detektion](../io.gitlab.arturbosch.detekt.api/-detektion/index.html) | Storage for all kinds of findings and additional information which needs to be transferred from the detekt engine to the user. | +| [io.gitlab.arturbosch.detekt.api.internal.DetektPomModel](../io.gitlab.arturbosch.detekt.api.internal/-detekt-pom-model/index.html) | Adapted from https://github.com/pinterest/ktlint/blob/master/ktlint-core/src/main/kotlin/com/pinterest/ktlint/core/KtLint.kt Licenced under the MIT licence - https://github.com/pinterest/ktlint/blob/master/LICENSE | | [io.gitlab.arturbosch.detekt.api.DetektVisitor](../io.gitlab.arturbosch.detekt.api/-detekt-visitor/index.html) | Basic visitor which is used inside detekt. Guarantees a better looking name as the extended base class :). | | [io.gitlab.arturbosch.detekt.api.Entity](../io.gitlab.arturbosch.detekt.api/-entity/index.html) | Stores information about a specific code fragment. | | [io.gitlab.arturbosch.detekt.api.Extension](../io.gitlab.arturbosch.detekt.api/-extension/index.html) | Defines extension points in detekt. Currently supported extensions are: | @@ -24,6 +26,7 @@ title: alltypes - detekt-api | [io.gitlab.arturbosch.detekt.api.Finding](../io.gitlab.arturbosch.detekt.api/-finding/index.html) | Base interface of detection findings. Inherits a bunch of useful behaviour from sub interfaces. | | [io.gitlab.arturbosch.detekt.api.HasEntity](../io.gitlab.arturbosch.detekt.api/-has-entity/index.html) | Describes a source code position. | | [io.gitlab.arturbosch.detekt.api.HasMetrics](../io.gitlab.arturbosch.detekt.api/-has-metrics/index.html) | Adds metric container behaviour. | +| [io.gitlab.arturbosch.detekt.api.HierarchicalConfig](../io.gitlab.arturbosch.detekt.api/-hierarchical-config/index.html) | A configuration which keeps track of the config it got sub-config'ed from by the [subConfig](../io.gitlab.arturbosch.detekt.api/-config/sub-config.html) function. It's main usage is to recreate the property-path which was taken when using the [subConfig](../io.gitlab.arturbosch.detekt.api/-config/sub-config.html) function repeatedly. | | [io.gitlab.arturbosch.detekt.api.Issue](../io.gitlab.arturbosch.detekt.api/-issue/index.html) | An issue represents a problem in the codebase. | | [org.jetbrains.kotlin.psi.KtAnnotated](../io.gitlab.arturbosch.detekt.api/org.jetbrains.kotlin.psi.-kt-annotated/index.html) (extensions in package io.gitlab.arturbosch.detekt.api) | | | [org.jetbrains.kotlin.psi.KtCallExpression](../io.gitlab.arturbosch.detekt.api.internal/org.jetbrains.kotlin.psi.-kt-call-expression/index.html) (extensions in package io.gitlab.arturbosch.detekt.api.internal) | | @@ -36,6 +39,7 @@ title: alltypes - detekt-api | [io.gitlab.arturbosch.detekt.api.MultiRule](../io.gitlab.arturbosch.detekt.api/-multi-rule/index.html) | | | [io.gitlab.arturbosch.detekt.api.Notification](../io.gitlab.arturbosch.detekt.api/-notification/index.html) | Any kind of notification which should be printed to the console. For example when using the formatting rule set, any change to your kotlin file is a notification. | | [io.gitlab.arturbosch.detekt.api.OutputReport](../io.gitlab.arturbosch.detekt.api/-output-report/index.html) | Translates detekt's result container - [Detektion](../io.gitlab.arturbosch.detekt.api/-detektion/index.html) - into an output report which is written inside a file. | +| [io.gitlab.arturbosch.detekt.api.internal.PathFilters](../io.gitlab.arturbosch.detekt.api.internal/-path-filters/index.html) | | | [io.gitlab.arturbosch.detekt.api.ProjectMetric](../io.gitlab.arturbosch.detekt.api/-project-metric/index.html) | Anything that can be expressed as a number value for projects. | | [io.gitlab.arturbosch.detekt.api.Rule](../io.gitlab.arturbosch.detekt.api/-rule/index.html) | A rule defines how one specific code structure should look like. If code is found which does not meet this structure, it is considered as harmful regarding maintainability or readability. | | [io.gitlab.arturbosch.detekt.api.RuleId](../io.gitlab.arturbosch.detekt.api/-rule-id.html) | The type to use when referring to rule ids giving it more context then a String would. | diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api.internal/-detekt-pom-model/-init-.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api.internal/-detekt-pom-model/-init-.md new file mode 100644 index 000000000..901242b9e --- /dev/null +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api.internal/-detekt-pom-model/-init-.md @@ -0,0 +1,13 @@ +--- +title: DetektPomModel. - detekt-api +--- + +[detekt-api](../../index.html) / [io.gitlab.arturbosch.detekt.api.internal](../index.html) / [DetektPomModel](index.html) / [<init>](./-init-.html) + +# <init> + +`DetektPomModel(project: Project)` + +Adapted from https://github.com/pinterest/ktlint/blob/master/ktlint-core/src/main/kotlin/com/pinterest/ktlint/core/KtLint.kt +Licenced under the MIT licence - https://github.com/pinterest/ktlint/blob/master/LICENSE + diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api.internal/-detekt-pom-model/get-model-aspect.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api.internal/-detekt-pom-model/get-model-aspect.md new file mode 100644 index 000000000..8bd92c178 --- /dev/null +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api.internal/-detekt-pom-model/get-model-aspect.md @@ -0,0 +1,9 @@ +--- +title: DetektPomModel.getModelAspect - detekt-api +--- + +[detekt-api](../../index.html) / [io.gitlab.arturbosch.detekt.api.internal](../index.html) / [DetektPomModel](index.html) / [getModelAspect](./get-model-aspect.html) + +# getModelAspect + +`fun getModelAspect(aspect: `[`Class`](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html)`<`[`T`](get-model-aspect.html#T)`>): `[`T`](get-model-aspect.html#T)`?` \ No newline at end of file diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api.internal/-detekt-pom-model/index.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api.internal/-detekt-pom-model/index.md new file mode 100644 index 000000000..9353a1335 --- /dev/null +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api.internal/-detekt-pom-model/index.md @@ -0,0 +1,22 @@ +--- +title: DetektPomModel - detekt-api +--- + +[detekt-api](../../index.html) / [io.gitlab.arturbosch.detekt.api.internal](../index.html) / [DetektPomModel](./index.html) + +# DetektPomModel + +`class DetektPomModel : UserDataHolderBase, PomModel` + +Adapted from https://github.com/pinterest/ktlint/blob/master/ktlint-core/src/main/kotlin/com/pinterest/ktlint/core/KtLint.kt +Licenced under the MIT licence - https://github.com/pinterest/ktlint/blob/master/LICENSE + +### Constructors + +| [<init>](-init-.html) | `DetektPomModel(project: Project)`
Adapted from https://github.com/pinterest/ktlint/blob/master/ktlint-core/src/main/kotlin/com/pinterest/ktlint/core/KtLint.kt Licenced under the MIT licence - https://github.com/pinterest/ktlint/blob/master/LICENSE | + +### Functions + +| [getModelAspect](get-model-aspect.html) | `fun getModelAspect(aspect: `[`Class`](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html)`<`[`T`](get-model-aspect.html#T)`>): `[`T`](get-model-aspect.html#T)`?` | +| [runTransaction](run-transaction.html) | `fun runTransaction(transaction: PomTransaction): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | + diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api.internal/-detekt-pom-model/run-transaction.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api.internal/-detekt-pom-model/run-transaction.md new file mode 100644 index 000000000..f83b03987 --- /dev/null +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api.internal/-detekt-pom-model/run-transaction.md @@ -0,0 +1,9 @@ +--- +title: DetektPomModel.runTransaction - detekt-api +--- + +[detekt-api](../../index.html) / [io.gitlab.arturbosch.detekt.api.internal](../index.html) / [DetektPomModel](index.html) / [runTransaction](./run-transaction.html) + +# runTransaction + +`fun runTransaction(transaction: PomTransaction): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api.internal/-mc-cabe-visitor/-init-.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api.internal/-mc-cabe-visitor/-init-.md index 693846ce0..29536e6b4 100644 --- a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api.internal/-mc-cabe-visitor/-init-.md +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api.internal/-mc-cabe-visitor/-init-.md @@ -10,12 +10,3 @@ title: McCabeVisitor. - detekt-api Counts the cyclomatic complexity of functions. -**Author** -Artur Bosch - -**Author** -schalkms - -**Author** -Sebastiano Poggi - diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api.internal/-mc-cabe-visitor/index.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api.internal/-mc-cabe-visitor/index.md index c3db0391d..8db3561ba 100644 --- a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api.internal/-mc-cabe-visitor/index.md +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api.internal/-mc-cabe-visitor/index.md @@ -10,15 +10,6 @@ title: McCabeVisitor - detekt-api Counts the cyclomatic complexity of functions. -**Author** -Artur Bosch - -**Author** -schalkms - -**Author** -Sebastiano Poggi - ### Constructors | [<init>](-init-.html) | `McCabeVisitor(ignoreSimpleWhenEntries: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`)`
Counts the cyclomatic complexity of functions. | diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api.internal/-path-filters/index.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api.internal/-path-filters/index.md new file mode 100644 index 000000000..846ebbad9 --- /dev/null +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api.internal/-path-filters/index.md @@ -0,0 +1,18 @@ +--- +title: PathFilters - detekt-api +--- + +[detekt-api](../../index.html) / [io.gitlab.arturbosch.detekt.api.internal](../index.html) / [PathFilters](./index.html) + +# PathFilters + +`class PathFilters` + +### Functions + +| [isIgnored](is-ignored.html) | `fun isIgnored(path: `[`Path`](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | + +### Companion Object Functions + +| [of](of.html) | `fun of(includes: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?, excludes: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?): `[`PathFilters`](./index.html)`?` | + diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api.internal/-path-filters/is-ignored.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api.internal/-path-filters/is-ignored.md new file mode 100644 index 000000000..67c2aefe6 --- /dev/null +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api.internal/-path-filters/is-ignored.md @@ -0,0 +1,9 @@ +--- +title: PathFilters.isIgnored - detekt-api +--- + +[detekt-api](../../index.html) / [io.gitlab.arturbosch.detekt.api.internal](../index.html) / [PathFilters](index.html) / [isIgnored](./is-ignored.html) + +# isIgnored + +`fun isIgnored(path: `[`Path`](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) \ No newline at end of file diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api.internal/-path-filters/of.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api.internal/-path-filters/of.md new file mode 100644 index 000000000..a53adec9d --- /dev/null +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api.internal/-path-filters/of.md @@ -0,0 +1,9 @@ +--- +title: PathFilters.of - detekt-api +--- + +[detekt-api](../../index.html) / [io.gitlab.arturbosch.detekt.api.internal](../index.html) / [PathFilters](index.html) / [of](./of.html) + +# of + +`fun of(includes: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?, excludes: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?): `[`PathFilters`](index.html)`?` \ No newline at end of file diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api.internal/create-compiler-configuration.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api.internal/create-compiler-configuration.md new file mode 100644 index 000000000..72f412496 --- /dev/null +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api.internal/create-compiler-configuration.md @@ -0,0 +1,13 @@ +--- +title: createCompilerConfiguration - detekt-api +--- + +[detekt-api](../index.html) / [io.gitlab.arturbosch.detekt.api.internal](index.html) / [createCompilerConfiguration](./create-compiler-configuration.html) + +# createCompilerConfiguration + +`fun createCompilerConfiguration(pathsToAnalyze: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Path`](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html)`>, classpath: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>, jvmTarget: JvmTarget): CompilerConfiguration` + +Creates a compiler configuration for the kotlin compiler with all known sources and classpath jars. +Be aware that if any path of [pathsToAnalyze](create-compiler-configuration.html#io.gitlab.arturbosch.detekt.api.internal$createCompilerConfiguration(kotlin.collections.List((java.nio.file.Path)), kotlin.collections.List((kotlin.String)), org.jetbrains.kotlin.config.JvmTarget)/pathsToAnalyze) is a directory it is scanned for java and kotlin files. + diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api.internal/create-kotlin-core-environment.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api.internal/create-kotlin-core-environment.md new file mode 100644 index 000000000..f5f64fa79 --- /dev/null +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api.internal/create-kotlin-core-environment.md @@ -0,0 +1,13 @@ +--- +title: createKotlinCoreEnvironment - detekt-api +--- + +[detekt-api](../index.html) / [io.gitlab.arturbosch.detekt.api.internal](index.html) / [createKotlinCoreEnvironment](./create-kotlin-core-environment.html) + +# createKotlinCoreEnvironment + +`fun createKotlinCoreEnvironment(configuration: CompilerConfiguration = CompilerConfiguration()): KotlinCoreEnvironment` + +Creates an environment instance which can be used to compile source code to KtFile's. +This environment also allows to modify the resulting AST files. + diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api.internal/index.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api.internal/index.md index ab915bb85..d1c193028 100644 --- a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api.internal/index.md +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api.internal/index.md @@ -8,7 +8,9 @@ title: io.gitlab.arturbosch.detekt.api.internal - detekt-api ### Types +| [DetektPomModel](-detekt-pom-model/index.html) | `class DetektPomModel : UserDataHolderBase, PomModel`
Adapted from https://github.com/pinterest/ktlint/blob/master/ktlint-core/src/main/kotlin/com/pinterest/ktlint/core/KtLint.kt Licenced under the MIT licence - https://github.com/pinterest/ktlint/blob/master/LICENSE | | [McCabeVisitor](-mc-cabe-visitor/index.html) | `class McCabeVisitor : `[`DetektVisitor`](../io.gitlab.arturbosch.detekt.api/-detekt-visitor/index.html)
Counts the cyclomatic complexity of functions. | +| [PathFilters](-path-filters/index.html) | `class PathFilters` | ### Extensions for External Classes @@ -22,5 +24,7 @@ title: io.gitlab.arturbosch.detekt.api.internal - detekt-api ### Functions +| [createCompilerConfiguration](create-compiler-configuration.html) | `fun createCompilerConfiguration(pathsToAnalyze: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Path`](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html)`>, classpath: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>, jvmTarget: JvmTarget): CompilerConfiguration`
Creates a compiler configuration for the kotlin compiler with all known sources and classpath jars. Be aware that if any path of [pathsToAnalyze](create-compiler-configuration.html#io.gitlab.arturbosch.detekt.api.internal$createCompilerConfiguration(kotlin.collections.List((java.nio.file.Path)), kotlin.collections.List((kotlin.String)), org.jetbrains.kotlin.config.JvmTarget)/pathsToAnalyze) is a directory it is scanned for java and kotlin files. | +| [createKotlinCoreEnvironment](create-kotlin-core-environment.html) | `fun createKotlinCoreEnvironment(configuration: CompilerConfiguration = CompilerConfiguration()): KotlinCoreEnvironment`
Creates an environment instance which can be used to compile source code to KtFile's. This environment also allows to modify the resulting AST files. | | [pathMatcher](path-matcher.html) | `fun pathMatcher(pattern: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`PathMatcher`](https://docs.oracle.com/javase/8/docs/api/java/nio/file/PathMatcher.html)
Converts given [pattern](path-matcher.html#io.gitlab.arturbosch.detekt.api.internal$pathMatcher(kotlin.String)/pattern) into a [PathMatcher](https://docs.oracle.com/javase/8/docs/api/java/nio/file/PathMatcher.html) specified by [FileSystem.getPathMatcher](https://docs.oracle.com/javase/8/docs/api/java/nio/file/FileSystem.html#getPathMatcher(java.lang.String)). We only support the "glob:" syntax to stay os independently. Internally a globbing pattern is transformed to a regex respecting the Windows file system. | diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api.internal/org.jetbrains.kotlin.psi.-kt-file/absolute-path.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api.internal/org.jetbrains.kotlin.psi.-kt-file/absolute-path.md index ef7361f59..4fd3ef46d 100644 --- a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api.internal/org.jetbrains.kotlin.psi.-kt-file/absolute-path.md +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api.internal/org.jetbrains.kotlin.psi.-kt-file/absolute-path.md @@ -6,4 +6,4 @@ title: absolutePath - detekt-api # absolutePath -`fun KtFile.absolutePath(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` \ No newline at end of file +`fun KtFile.absolutePath(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api.internal/org.jetbrains.kotlin.psi.-kt-file/index.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api.internal/org.jetbrains.kotlin.psi.-kt-file/index.md index d6e920003..0ecc0401a 100644 --- a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api.internal/org.jetbrains.kotlin.psi.-kt-file/index.md +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api.internal/org.jetbrains.kotlin.psi.-kt-file/index.md @@ -6,6 +6,6 @@ title: io.gitlab.arturbosch.detekt.api.internal.org.jetbrains.kotlin.psi.KtFile ### Extensions for org.jetbrains.kotlin.psi.KtFile -| [absolutePath](absolute-path.html) | `fun KtFile.absolutePath(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` | -| [relativePath](relative-path.html) | `fun KtFile.relativePath(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` | +| [absolutePath](absolute-path.html) | `fun KtFile.absolutePath(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [relativePath](relative-path.html) | `fun KtFile.relativePath(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api.internal/org.jetbrains.kotlin.psi.-kt-file/relative-path.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api.internal/org.jetbrains.kotlin.psi.-kt-file/relative-path.md index 89f856bef..8071068d3 100644 --- a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api.internal/org.jetbrains.kotlin.psi.-kt-file/relative-path.md +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api.internal/org.jetbrains.kotlin.psi.-kt-file/relative-path.md @@ -6,4 +6,4 @@ title: relativePath - detekt-api # relativePath -`fun KtFile.relativePath(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` \ No newline at end of file +`fun KtFile.relativePath(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-annotation-excluder/-init-.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-annotation-excluder/-init-.md index 037806140..2f74dc273 100644 --- a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-annotation-excluder/-init-.md +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-annotation-excluder/-init-.md @@ -12,12 +12,3 @@ Primary use case for an AnnotationExcluder is to decide if a KtElement should be excluded from further analysis. This is done by checking if a special annotation is present over the element. -**Author** -Niklas Baudy - -**Author** -Artur Bosch - -**Author** -schalkms - diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-annotation-excluder/index.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-annotation-excluder/index.md index 86592bea6..d830052ad 100644 --- a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-annotation-excluder/index.md +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-annotation-excluder/index.md @@ -12,15 +12,6 @@ Primary use case for an AnnotationExcluder is to decide if a KtElement should be excluded from further analysis. This is done by checking if a special annotation is present over the element. -**Author** -Niklas Baudy - -**Author** -Artur Bosch - -**Author** -schalkms - ### Constructors | [<init>](-init-.html) | `AnnotationExcluder(root: KtFile, excludes: `[`SplitPattern`](../-split-pattern/index.html)`)`
Primary use case for an AnnotationExcluder is to decide if a KtElement should be excluded from further analysis. This is done by checking if a special annotation is present over the element. | diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-base-config/index.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-base-config/index.md index 325dae25e..52f309072 100644 --- a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-base-config/index.md +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-base-config/index.md @@ -6,7 +6,7 @@ title: BaseConfig - detekt-api # BaseConfig -`abstract class BaseConfig : `[`Config`](../-config/index.html) +`abstract class BaseConfig : `[`HierarchicalConfig`](../-hierarchical-config/index.html) Convenient base configuration which parses/casts the configuration value based on the type of the default value. @@ -14,17 +14,15 @@ Convenient base configuration which parses/casts the configuration value based o | [<init>](-init-.html) | `BaseConfig()`
Convenient base configuration which parses/casts the configuration value based on the type of the default value. | +### Inherited Properties + +| [parent](../-hierarchical-config/parent.html) | `abstract val parent: `[`HierarchicalConfig.Parent`](../-hierarchical-config/-parent/index.html)`?`
Returns the parent config which encloses this config part. | + ### Functions | [tryParseBasedOnDefault](try-parse-based-on-default.html) | `open fun tryParseBasedOnDefault(result: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, defaultResult: `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | | [valueOrDefaultInternal](value-or-default-internal.html) | `open fun valueOrDefaultInternal(key: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, result: `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`?, default: `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | -### Inherited Functions - -| [subConfig](../-config/sub-config.html) | `abstract fun subConfig(key: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Config`](../-config/index.html)
Tries to retrieve part of the configuration based on given key. | -| [valueOrDefault](../-config/value-or-default.html) | `abstract fun valueOrDefault(key: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, default: `[`T`](../-config/value-or-default.html#T)`): `[`T`](../-config/value-or-default.html#T)
Retrieves a sub configuration or value based on given key. If configuration property cannot be found the specified default value is returned. | -| [valueOrNull](../-config/value-or-null.html) | `abstract fun valueOrNull(key: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`T`](../-config/value-or-null.html#T)`?`
Retrieves a sub configuration or value based on given key. If the configuration property cannot be found, null is returned. | - ### Inheritors | [YamlConfig](../-yaml-config/index.html) | `class YamlConfig : `[`BaseConfig`](./index.html)
Config implementation using the yaml format. SubConfigurations can return sub maps according to the yaml specification. | diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-code-smell/-init-.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-code-smell/-init-.md index e3ac5292b..502f58b0d 100644 --- a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-code-smell/-init-.md +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-code-smell/-init-.md @@ -17,9 +17,3 @@ can describe further the kind of metrics. If the design problem manifests by different source locations, references to these locations can be stored in additional [Entity](../-entity/index.html)'s. -**Author** -Artur Bosch - -**Author** -Marvin Ramin - diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-code-smell/index.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-code-smell/index.md index 8632c48fa..86b5020bc 100644 --- a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-code-smell/index.md +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-code-smell/index.md @@ -17,12 +17,6 @@ can describe further the kind of metrics. If the design problem manifests by different source locations, references to these locations can be stored in additional [Entity](../-entity/index.html)'s. -**Author** -Artur Bosch - -**Author** -Marvin Ramin - ### Constructors | [<init>](-init-.html) | `CodeSmell(issue: `[`Issue`](../-issue/index.html)`, entity: `[`Entity`](../-entity/index.html)`, message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, metrics: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Metric`](../-metric/index.html)`> = listOf(), references: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Entity`](../-entity/index.html)`> = listOf())`
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](../-issue/index.html). | @@ -45,5 +39,6 @@ Marvin Ramin ### Inheritors +| [CorrectableCodeSmell](../-correctable-code-smell/index.html) | `open class CorrectableCodeSmell : `[`CodeSmell`](./index.html)
Represents a code smell for that can be auto corrected. | | [ThresholdedCodeSmell](../-thresholded-code-smell/index.html) | `open class ThresholdedCodeSmell : `[`CodeSmell`](./index.html)
Represents a code smell for which a specific metric can be determined which is responsible for the existence of this rule violation. | diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-composite-config/-init-.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-composite-config/-init-.md index 9f4ddf4e4..487de85cc 100644 --- a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-composite-config/-init-.md +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-composite-config/-init-.md @@ -10,6 +10,3 @@ title: CompositeConfig. - detekt-api Wraps two different configuration which should be considered when retrieving properties. -**Author** -Artur Bosch - diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-composite-config/index.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-composite-config/index.md index 37da20707..137e28a51 100644 --- a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-composite-config/index.md +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-composite-config/index.md @@ -10,9 +10,6 @@ title: CompositeConfig - detekt-api Wraps two different configuration which should be considered when retrieving properties. -**Author** -Artur Bosch - ### Constructors | [<init>](-init-.html) | `CompositeConfig(lookFirst: `[`Config`](../-config/index.html)`, lookSecond: `[`Config`](../-config/index.html)`)`
Wraps two different configuration which should be considered when retrieving properties. | diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-config-aware/index.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-config-aware/index.md index 36d7d3fde..583f4f7d9 100644 --- a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-config-aware/index.md +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-config-aware/index.md @@ -23,9 +23,6 @@ rule in the #RuleSetProvider interface. This is due the fact that users create t rule set and all rules upfront and letting them 'sub config' the rule set config would be error-prone. -**Author** -Artur Bosch - ### Properties | [active](active.html) | `open val active: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Is this rule specified as active in configuration? If an rule is not specified in the underlying configuration, we assume it should not be run. | diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-config/-a-c-t-i-v-e_-k-e-y.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-config/-a-c-t-i-v-e_-k-e-y.md new file mode 100644 index 000000000..cbe43122c --- /dev/null +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-config/-a-c-t-i-v-e_-k-e-y.md @@ -0,0 +1,9 @@ +--- +title: Config.ACTIVE_KEY - detekt-api +--- + +[detekt-api](../../index.html) / [io.gitlab.arturbosch.detekt.api](../index.html) / [Config](index.html) / [ACTIVE_KEY](./-a-c-t-i-v-e_-k-e-y.html) + +# ACTIVE_KEY + +`const val ACTIVE_KEY: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-config/-invalid-configuration-error/-init-.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-config/-invalid-configuration-error/-init-.md index 10b171ed9..b359b21e2 100644 --- a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-config/-invalid-configuration-error/-init-.md +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-config/-invalid-configuration-error/-init-.md @@ -7,7 +7,7 @@ title: Config.InvalidConfigurationError. - detekt-api # <init> `InvalidConfigurationError(msg: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = "Provided configuration file is invalid:" + - " Structure must be from type Map!")` + " Structure must be from type Map!")` Is thrown when loading a configuration results in errors. diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-config/-invalid-configuration-error/index.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-config/-invalid-configuration-error/index.md index 823460e73..beeeb2e3c 100644 --- a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-config/-invalid-configuration-error/index.md +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-config/-invalid-configuration-error/index.md @@ -13,5 +13,5 @@ Is thrown when loading a configuration results in errors. ### Constructors | [<init>](-init-.html) | `InvalidConfigurationError(msg: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = "Provided configuration file is invalid:" + - " Structure must be from type Map!")`
Is thrown when loading a configuration results in errors. | + " Structure must be from type Map!")`
Is thrown when loading a configuration results in errors. | diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-config/-p-r-i-m-i-t-i-v-e-s.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-config/-p-r-i-m-i-t-i-v-e-s.md new file mode 100644 index 000000000..6e2ecfe6e --- /dev/null +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-config/-p-r-i-m-i-t-i-v-e-s.md @@ -0,0 +1,9 @@ +--- +title: Config.PRIMITIVES - detekt-api +--- + +[detekt-api](../../index.html) / [io.gitlab.arturbosch.detekt.api](../index.html) / [Config](index.html) / [PRIMITIVES](./-p-r-i-m-i-t-i-v-e-s.html) + +# PRIMITIVES + +`val PRIMITIVES: `[`Set`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html)`<`[`KClass`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.html)`>` \ No newline at end of file diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-config/index.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-config/index.md index 4a9f53a5a..03e028017 100644 --- a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-config/index.md +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-config/index.md @@ -10,12 +10,6 @@ title: Config - detekt-api A configuration holds information about how to configure specific rules. -**Author** -Artur Bosch - -**Author** -schalkms - ### Exceptions | [InvalidConfigurationError](-invalid-configuration-error/index.html) | `class InvalidConfigurationError : `[`RuntimeException`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-runtime-exception/index.html)
Is thrown when loading a configuration results in errors. | @@ -28,13 +22,15 @@ schalkms ### Companion Object Properties +| [ACTIVE_KEY](-a-c-t-i-v-e_-k-e-y.html) | `const val ACTIVE_KEY: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | | [empty](empty.html) | `val empty: `[`Config`](./index.html)
An empty configuration with no properties. This config should only be used in test cases. Always returns the default value except when 'active' is queried, it returns true . | | [EXCLUDES_KEY](-e-x-c-l-u-d-e-s_-k-e-y.html) | `const val EXCLUDES_KEY: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | | [INCLUDES_KEY](-i-n-c-l-u-d-e-s_-k-e-y.html) | `const val INCLUDES_KEY: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [PRIMITIVES](-p-r-i-m-i-t-i-v-e-s.html) | `val PRIMITIVES: `[`Set`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html)`<`[`KClass`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.html)`>` | ### Inheritors -| [BaseConfig](../-base-config/index.html) | `abstract class BaseConfig : `[`Config`](./index.html)
Convenient base configuration which parses/casts the configuration value based on the type of the default value. | | [CompositeConfig](../-composite-config/index.html) | `class CompositeConfig : `[`Config`](./index.html)
Wraps two different configuration which should be considered when retrieving properties. | | [ConfigAware](../-config-aware/index.html) | `interface ConfigAware : `[`Config`](./index.html)
Interface which is implemented by each Rule class to provide utility functions to retrieve specific or generic properties from the underlying detekt configuration file. | +| [HierarchicalConfig](../-hierarchical-config/index.html) | `interface HierarchicalConfig : `[`Config`](./index.html)
A configuration which keeps track of the config it got sub-config'ed from by the [subConfig](sub-config.html) function. It's main usage is to recreate the property-path which was taken when using the [subConfig](sub-config.html) function repeatedly. | diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-console-report/-init-.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-console-report/-init-.md index 6ccd1a815..68878aa59 100644 --- a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-console-report/-init-.md +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-console-report/-init-.md @@ -14,6 +14,3 @@ Additional [ConsoleReport](index.html)'s can be made available through the [java If the default reporting mechanism should be turned off, exclude the entry 'FindingsReport' in the 'console-reports' property of a detekt yaml config. -**Author** -Artur Bosch - diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-console-report/index.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-console-report/index.md index 9c99b3c5c..32ad6cb54 100644 --- a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-console-report/index.md +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-console-report/index.md @@ -14,9 +14,6 @@ Additional [ConsoleReport](./index.html)'s can be made available through the [ja If the default reporting mechanism should be turned off, exclude the entry 'FindingsReport' in the 'console-reports' property of a detekt yaml config. -**Author** -Artur Bosch - ### Constructors | [<init>](-init-.html) | `ConsoleReport()`
Extension point which describes how findings should be printed on the console. | diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-context/index.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-context/index.md index 4281df01b..e33c8ca0f 100644 --- a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-context/index.md +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-context/index.md @@ -14,12 +14,6 @@ Additionally it handles suppression and aliases management. The detekt engine retrieves the findings after each KtFile visit and resets the context before the next KtFile. -**Author** -Artur Bosch - -**Author** -Marvin Ramin - ### Properties | [findings](findings.html) | `abstract val findings: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Finding`](../-finding/index.html)`>` | diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-correctable-code-smell/-init-.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-correctable-code-smell/-init-.md new file mode 100644 index 000000000..77c3b8f99 --- /dev/null +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-correctable-code-smell/-init-.md @@ -0,0 +1,16 @@ +--- +title: CorrectableCodeSmell. - detekt-api +--- + +[detekt-api](../../index.html) / [io.gitlab.arturbosch.detekt.api](../index.html) / [CorrectableCodeSmell](index.html) / [<init>](./-init-.html) + +# <init> + +`CorrectableCodeSmell(issue: `[`Issue`](../-issue/index.html)`, entity: `[`Entity`](../-entity/index.html)`, message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, metrics: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Metric`](../-metric/index.html)`> = listOf(), references: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Entity`](../-entity/index.html)`> = listOf(), autoCorrectEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`)` + +Represents a code smell for that can be auto corrected. + +**See Also** + +[CodeSmell](../-code-smell/index.html) + diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-correctable-code-smell/auto-correct-enabled.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-correctable-code-smell/auto-correct-enabled.md new file mode 100644 index 000000000..4546ab57f --- /dev/null +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-correctable-code-smell/auto-correct-enabled.md @@ -0,0 +1,9 @@ +--- +title: CorrectableCodeSmell.autoCorrectEnabled - detekt-api +--- + +[detekt-api](../../index.html) / [io.gitlab.arturbosch.detekt.api](../index.html) / [CorrectableCodeSmell](index.html) / [autoCorrectEnabled](./auto-correct-enabled.html) + +# autoCorrectEnabled + +`val autoCorrectEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) \ No newline at end of file diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-correctable-code-smell/index.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-correctable-code-smell/index.md new file mode 100644 index 000000000..2cb669a1a --- /dev/null +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-correctable-code-smell/index.md @@ -0,0 +1,43 @@ +--- +title: CorrectableCodeSmell - detekt-api +--- + +[detekt-api](../../index.html) / [io.gitlab.arturbosch.detekt.api](../index.html) / [CorrectableCodeSmell](./index.html) + +# CorrectableCodeSmell + +`open class CorrectableCodeSmell : `[`CodeSmell`](../-code-smell/index.html) + +Represents a code smell for that can be auto corrected. + +**See Also** + +[CodeSmell](../-code-smell/index.html) + +### Constructors + +| [<init>](-init-.html) | `CorrectableCodeSmell(issue: `[`Issue`](../-issue/index.html)`, entity: `[`Entity`](../-entity/index.html)`, message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, metrics: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Metric`](../-metric/index.html)`> = listOf(), references: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Entity`](../-entity/index.html)`> = listOf(), autoCorrectEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`)`
Represents a code smell for that can be auto corrected. | + +### Properties + +| [autoCorrectEnabled](auto-correct-enabled.html) | `val autoCorrectEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | + +### Inherited Properties + +| [entity](../-code-smell/entity.html) | `open val entity: `[`Entity`](../-entity/index.html) | +| [id](../-code-smell/id.html) | `open val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [issue](../-code-smell/issue.html) | `val issue: `[`Issue`](../-issue/index.html) | +| [message](../-code-smell/message.html) | `open val message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [metrics](../-code-smell/metrics.html) | `open val metrics: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Metric`](../-metric/index.html)`>` | +| [references](../-code-smell/references.html) | `open val references: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Entity`](../-entity/index.html)`>` | + +### Functions + +| [toString](to-string.html) | `open fun toString(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + +### Inherited Functions + +| [compact](../-code-smell/compact.html) | `open fun compact(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [compactWithSignature](../-code-smell/compact-with-signature.html) | `open fun compactWithSignature(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [messageOrDescription](../-code-smell/message-or-description.html) | `open fun messageOrDescription(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-correctable-code-smell/to-string.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-correctable-code-smell/to-string.md new file mode 100644 index 000000000..437f65d95 --- /dev/null +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-correctable-code-smell/to-string.md @@ -0,0 +1,12 @@ +--- +title: CorrectableCodeSmell.toString - detekt-api +--- + +[detekt-api](../../index.html) / [io.gitlab.arturbosch.detekt.api](../index.html) / [CorrectableCodeSmell](index.html) / [toString](./to-string.html) + +# toString + +`open fun toString(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) + +Overrides [CodeSmell.toString](../-code-smell/to-string.html) + diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-detekt-visitor/-init-.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-detekt-visitor/-init-.md index 662ac6784..600d96da7 100644 --- a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-detekt-visitor/-init-.md +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-detekt-visitor/-init-.md @@ -11,6 +11,3 @@ title: DetektVisitor. - detekt-api Basic visitor which is used inside detekt. Guarantees a better looking name as the extended base class :). -**Author** -Artur Bosch - diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-detekt-visitor/index.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-detekt-visitor/index.md index 42e157419..0d33dcc7a 100644 --- a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-detekt-visitor/index.md +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-detekt-visitor/index.md @@ -11,9 +11,6 @@ title: DetektVisitor - detekt-api Basic visitor which is used inside detekt. Guarantees a better looking name as the extended base class :). -**Author** -Artur Bosch - ### Constructors | [<init>](-init-.html) | `DetektVisitor()`
Basic visitor which is used inside detekt. Guarantees a better looking name as the extended base class :). | diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-detektion/index.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-detektion/index.md index e7363d85a..737bf312b 100644 --- a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-detektion/index.md +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-detektion/index.md @@ -11,9 +11,6 @@ title: Detektion - detekt-api Storage for all kinds of findings and additional information which needs to be transferred from the detekt engine to the user. -**Author** -Artur Bosch - ### Properties | [findings](findings.html) | `abstract val findings: `[`Map`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html)`<`[`RuleSetId`](../-rule-set-id.html)`, `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Finding`](../-finding/index.html)`>>` | diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-entity/-init-.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-entity/-init-.md index 7e40f4485..d02da3759 100644 --- a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-entity/-init-.md +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-entity/-init-.md @@ -10,6 +10,3 @@ title: Entity. - detekt-api Stores information about a specific code fragment. -**Author** -Artur Bosch - diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-entity/index.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-entity/index.md index f1b61fb46..2c3b2e204 100644 --- a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-entity/index.md +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-entity/index.md @@ -10,9 +10,6 @@ title: Entity - detekt-api Stores information about a specific code fragment. -**Author** -Artur Bosch - ### Constructors | [<init>](-init-.html) | `Entity(name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, className: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, signature: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, location: `[`Location`](../-location/index.html)`, ktElement: KtElement? = null)`
Stores information about a specific code fragment. | diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-extension/index.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-extension/index.md index bf44e41fb..f6b3867cf 100644 --- a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-extension/index.md +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-extension/index.md @@ -15,9 +15,6 @@ Currently supported extensions are: * [ConsoleReport](../-console-report/index.html) * [OutputReport](../-output-report/index.html) -**Author** -Artur Bosch - ### Properties | [id](id.html) | `open val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Name of the extension. | diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-file-process-listener/index.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-file-process-listener/index.md index d6252188d..fb5ddac7c 100644 --- a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-file-process-listener/index.md +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-file-process-listener/index.md @@ -11,9 +11,6 @@ title: FileProcessListener - detekt-api Gather additional metrics about the analyzed kotlin file. Pay attention to the thread policy of each function! -**Author** -Artur Bosch - ### Inherited Properties | [id](../-extension/id.html) | `open val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Name of the extension. | diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-finding/index.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-finding/index.md index 4b1cb3ae5..0053b38ca 100644 --- a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-finding/index.md +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-finding/index.md @@ -14,9 +14,6 @@ from sub interfaces. Basic behaviour of a finding is that is can be assigned to an id and a source code position described as an entity. Metrics and entity references can also considered for deeper characterization. -**Author** -Artur Bosch - ### Properties | [id](id.html) | `abstract val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-hierarchical-config/-parent/-init-.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-hierarchical-config/-parent/-init-.md new file mode 100644 index 000000000..39069fe11 --- /dev/null +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-hierarchical-config/-parent/-init-.md @@ -0,0 +1,12 @@ +--- +title: HierarchicalConfig.Parent. - detekt-api +--- + +[detekt-api](../../../index.html) / [io.gitlab.arturbosch.detekt.api](../../index.html) / [HierarchicalConfig](../index.html) / [Parent](index.html) / [<init>](./-init-.html) + +# <init> + +`Parent(config: `[`Config`](../../-config/index.html)`, key: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)` + +Keeps track of which key was taken to [subConfig](../../-config/sub-config.html) this configuration. + diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-hierarchical-config/-parent/config.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-hierarchical-config/-parent/config.md new file mode 100644 index 000000000..0dd023dd3 --- /dev/null +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-hierarchical-config/-parent/config.md @@ -0,0 +1,9 @@ +--- +title: HierarchicalConfig.Parent.config - detekt-api +--- + +[detekt-api](../../../index.html) / [io.gitlab.arturbosch.detekt.api](../../index.html) / [HierarchicalConfig](../index.html) / [Parent](index.html) / [config](./config.html) + +# config + +`val config: `[`Config`](../../-config/index.html) \ No newline at end of file diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-hierarchical-config/-parent/index.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-hierarchical-config/-parent/index.md new file mode 100644 index 000000000..480e43651 --- /dev/null +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-hierarchical-config/-parent/index.md @@ -0,0 +1,21 @@ +--- +title: HierarchicalConfig.Parent - detekt-api +--- + +[detekt-api](../../../index.html) / [io.gitlab.arturbosch.detekt.api](../../index.html) / [HierarchicalConfig](../index.html) / [Parent](./index.html) + +# Parent + +`data class Parent` + +Keeps track of which key was taken to [subConfig](../../-config/sub-config.html) this configuration. + +### Constructors + +| [<init>](-init-.html) | `Parent(config: `[`Config`](../../-config/index.html)`, key: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)`
Keeps track of which key was taken to [subConfig](../../-config/sub-config.html) this configuration. | + +### Properties + +| [config](config.html) | `val config: `[`Config`](../../-config/index.html) | +| [key](key.html) | `val key: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-hierarchical-config/-parent/key.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-hierarchical-config/-parent/key.md new file mode 100644 index 000000000..63cd401b0 --- /dev/null +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-hierarchical-config/-parent/key.md @@ -0,0 +1,9 @@ +--- +title: HierarchicalConfig.Parent.key - detekt-api +--- + +[detekt-api](../../../index.html) / [io.gitlab.arturbosch.detekt.api](../../index.html) / [HierarchicalConfig](../index.html) / [Parent](index.html) / [key](./key.html) + +# key + +`val key: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-hierarchical-config/index.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-hierarchical-config/index.md new file mode 100644 index 000000000..aea6234b3 --- /dev/null +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-hierarchical-config/index.md @@ -0,0 +1,31 @@ +--- +title: HierarchicalConfig - detekt-api +--- + +[detekt-api](../../index.html) / [io.gitlab.arturbosch.detekt.api](../index.html) / [HierarchicalConfig](./index.html) + +# HierarchicalConfig + +`interface HierarchicalConfig : `[`Config`](../-config/index.html) + +A configuration which keeps track of the config it got sub-config'ed from by the [subConfig](../-config/sub-config.html) function. +It's main usage is to recreate the property-path which was taken when using the [subConfig](../-config/sub-config.html) function repeatedly. + +### Types + +| [Parent](-parent/index.html) | `data class Parent`
Keeps track of which key was taken to [subConfig](../-config/sub-config.html) this configuration. | + +### Properties + +| [parent](parent.html) | `abstract val parent: `[`HierarchicalConfig.Parent`](-parent/index.html)`?`
Returns the parent config which encloses this config part. | + +### Inherited Functions + +| [subConfig](../-config/sub-config.html) | `abstract fun subConfig(key: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Config`](../-config/index.html)
Tries to retrieve part of the configuration based on given key. | +| [valueOrDefault](../-config/value-or-default.html) | `abstract fun valueOrDefault(key: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, default: `[`T`](../-config/value-or-default.html#T)`): `[`T`](../-config/value-or-default.html#T)
Retrieves a sub configuration or value based on given key. If configuration property cannot be found the specified default value is returned. | +| [valueOrNull](../-config/value-or-null.html) | `abstract fun valueOrNull(key: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`T`](../-config/value-or-null.html#T)`?`
Retrieves a sub configuration or value based on given key. If the configuration property cannot be found, null is returned. | + +### Inheritors + +| [BaseConfig](../-base-config/index.html) | `abstract class BaseConfig : `[`HierarchicalConfig`](./index.html)
Convenient base configuration which parses/casts the configuration value based on the type of the default value. | + diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-hierarchical-config/parent.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-hierarchical-config/parent.md new file mode 100644 index 000000000..903613ac3 --- /dev/null +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-hierarchical-config/parent.md @@ -0,0 +1,12 @@ +--- +title: HierarchicalConfig.parent - detekt-api +--- + +[detekt-api](../../index.html) / [io.gitlab.arturbosch.detekt.api](../index.html) / [HierarchicalConfig](index.html) / [parent](./parent.html) + +# parent + +`abstract val parent: `[`HierarchicalConfig.Parent`](-parent/index.html)`?` + +Returns the parent config which encloses this config part. + diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-issue/-init-.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-issue/-init-.md index 6c4a6ec41..37ba56043 100644 --- a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-issue/-init-.md +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-issue/-init-.md @@ -10,12 +10,3 @@ title: Issue. - detekt-api An issue represents a problem in the codebase. -**Author** -Artur Bosch - -**Author** -Marvin Ramin - -**Author** -schalkms - diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-issue/index.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-issue/index.md index 1ee306d95..7161a08c3 100644 --- a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-issue/index.md +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-issue/index.md @@ -10,15 +10,6 @@ title: Issue - detekt-api An issue represents a problem in the codebase. -**Author** -Artur Bosch - -**Author** -Marvin Ramin - -**Author** -schalkms - ### Constructors | [<init>](-init-.html) | `Issue(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, severity: `[`Severity`](../-severity/index.html)`, description: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, debt: `[`Debt`](../-debt/index.html)`)`
An issue represents a problem in the codebase. | diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-lazy-regex/-init-.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-lazy-regex/-init-.md index 323fd60be..84f13dea3 100644 --- a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-lazy-regex/-init-.md +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-lazy-regex/-init-.md @@ -14,6 +14,3 @@ value when requested again. `key` & `default` are used to retrieve a value from config. -**Author** -Pavlos-Petros Tournaris - diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-lazy-regex/index.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-lazy-regex/index.md index 0dac741a1..16d1ddf3a 100644 --- a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-lazy-regex/index.md +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-lazy-regex/index.md @@ -14,9 +14,6 @@ value when requested again. `key` & `default` are used to retrieve a value from config. -**Author** -Pavlos-Petros Tournaris - ### Constructors | [<init>](-init-.html) | `LazyRegex(key: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, default: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)`
LazyRegex class provides a lazy evaluation of a Regex pattern for usages inside Rules. It computes the value once when reaching the point of its usage and returns the same value when requested again. | diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-location/-init-.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-location/-init-.md index 2de7faa1c..996c1ffff 100644 --- a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-location/-init-.md +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-location/-init-.md @@ -10,6 +10,3 @@ title: Location. - detekt-api Specifies a position within a source code fragment. -**Author** -Artur Bosch - diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-location/index.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-location/index.md index aefd3e21d..982203cc1 100644 --- a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-location/index.md +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-location/index.md @@ -10,9 +10,6 @@ title: Location - detekt-api Specifies a position within a source code fragment. -**Author** -Artur Bosch - ### Constructors | [<init>](-init-.html) | `Location(source: `[`SourceLocation`](../-source-location/index.html)`, text: `[`TextLocation`](../-text-location/index.html)`, locationString: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, file: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)`
Specifies a position within a source code fragment. | diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-metric/-init-.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-metric/-init-.md index 366330f5b..c34415500 100644 --- a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-metric/-init-.md +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-metric/-init-.md @@ -11,6 +11,3 @@ title: Metric. - detekt-api Metric type, can be an integer or double value. Internally it is stored as an integer, but the conversion factor and is double attributes can be used to retrieve it as a double value. -**Author** -Artur Bosch - diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-metric/index.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-metric/index.md index ec6241cbf..96b15d37a 100644 --- a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-metric/index.md +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-metric/index.md @@ -11,9 +11,6 @@ title: Metric - detekt-api Metric type, can be an integer or double value. Internally it is stored as an integer, but the conversion factor and is double attributes can be used to retrieve it as a double value. -**Author** -Artur Bosch - ### Constructors | [<init>](-init-.html) | `Metric(type: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, value: `[`Double`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)`, threshold: `[`Double`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)`, conversionFactor: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = DEFAULT_FLOAT_CONVERSION_FACTOR)``Metric(type: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, value: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, threshold: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, isDouble: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, conversionFactor: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = DEFAULT_FLOAT_CONVERSION_FACTOR)`
Metric type, can be an integer or double value. Internally it is stored as an integer, but the conversion factor and is double attributes can be used to retrieve it as a double value. | diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-multi-rule/index.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-multi-rule/index.md index 7a4267def..5299a0924 100644 --- a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-multi-rule/index.md +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-multi-rule/index.md @@ -15,7 +15,6 @@ title: MultiRule - detekt-api ### Properties | [activeRules](active-rules.html) | `var activeRules: `[`Set`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html)`<`[`Rule`](../-rule/index.html)`>` | -| [ruleFilters](rule-filters.html) | `var ruleFilters: `[`Set`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html)`<`[`RuleId`](../-rule-id.html)`>` | | [rules](rules.html) | `abstract val rules: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Rule`](../-rule/index.html)`>` | ### Inherited Properties diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-notification/index.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-notification/index.md index fd7c437ae..aa3292c2c 100644 --- a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-notification/index.md +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-notification/index.md @@ -12,9 +12,6 @@ Any kind of notification which should be printed to the console. For example when using the formatting rule set, any change to your kotlin file is a notification. -**Author** -Artur Bosch - ### Properties | [message](message.html) | `abstract val message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-output-report/-init-.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-output-report/-init-.md index 5f9c953e3..d292c60cc 100644 --- a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-output-report/-init-.md +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-output-report/-init-.md @@ -11,9 +11,3 @@ title: OutputReport. - detekt-api Translates detekt's result container - [Detektion](../-detektion/index.html) - into an output report which is written inside a file. -**Author** -Artur Bosch - -**Author** -Marvin Ramin - diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-output-report/index.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-output-report/index.md index 4963c6dc0..ab7529a53 100644 --- a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-output-report/index.md +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-output-report/index.md @@ -11,12 +11,6 @@ title: OutputReport - detekt-api Translates detekt's result container - [Detektion](../-detektion/index.html) - into an output report which is written inside a file. -**Author** -Artur Bosch - -**Author** -Marvin Ramin - ### Constructors | [<init>](-init-.html) | `OutputReport()`
Translates detekt's result container - [Detektion](../-detektion/index.html) - into an output report which is written inside a file. | diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-project-metric/-init-.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-project-metric/-init-.md index 14868be7c..cc0284420 100644 --- a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-project-metric/-init-.md +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-project-metric/-init-.md @@ -10,6 +10,3 @@ title: ProjectMetric. - detekt-api Anything that can be expressed as a number value for projects. -**Author** -Artur Bosch - diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-project-metric/index.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-project-metric/index.md index a2f720737..75f599827 100644 --- a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-project-metric/index.md +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-project-metric/index.md @@ -10,9 +10,6 @@ title: ProjectMetric - detekt-api Anything that can be expressed as a number value for projects. -**Author** -Artur Bosch - ### Constructors | [<init>](-init-.html) | `ProjectMetric(type: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, value: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, priority: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = -1, isDouble: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, conversionFactor: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = DEFAULT_FLOAT_CONVERSION_FACTOR)`
Anything that can be expressed as a number value for projects. | diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-rule-set-provider/index.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-rule-set-provider/index.md index 9c8a8dba5..a4af52c71 100644 --- a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-rule-set-provider/index.md +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-rule-set-provider/index.md @@ -13,9 +13,6 @@ A rule set provider, as the name states, is responsible for creating rule sets. When writing own rule set providers make sure to register them according the ServiceLoader documentation. http://docs.oracle.com/javase/8/docs/api/java/util/ServiceLoader.html -**Author** -Artur Bosch - ### Properties | [ruleSetId](rule-set-id.html) | `abstract val ruleSetId: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Every rule set must be pre-configured with an ID to validate if this rule set must be created for current analysis. | diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-rule-set/-init-.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-rule-set/-init-.md index ff740292b..a5c02d9d4 100644 --- a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-rule-set/-init-.md +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-rule-set/-init-.md @@ -10,6 +10,3 @@ title: RuleSet. - detekt-api A rule set is a collection of rules and must be defined within a rule set provider implementation. -**Author** -Artur Bosch - diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-rule-set/accept.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-rule-set/accept.md index e0cbc68c2..3225a4f2b 100644 --- a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-rule-set/accept.md +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-rule-set/accept.md @@ -11,11 +11,3 @@ title: RuleSet.accept - detekt-api Visits given file with all rules of this rule set, returning a list of all code smell findings. -`fun accept(file: KtFile, ruleFilters: `[`Set`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html)`<`[`RuleId`](../-rule-id.html)`>, bindingContext: BindingContext = BindingContext.EMPTY): `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Finding`](../-finding/index.html)`>` - -Visits given file with all non-filtered rules of this rule set. -If a rule is a [MultiRule](../-multi-rule/index.html) the filters are passed to it via a setter -and later used to filter sub rules of the [MultiRule](../-multi-rule/index.html). - -A list of findings is returned for given KtFile - diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-rule-set/index.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-rule-set/index.md index 7b2082a05..7381229bb 100644 --- a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-rule-set/index.md +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-rule-set/index.md @@ -10,9 +10,6 @@ title: RuleSet - detekt-api A rule set is a collection of rules and must be defined within a rule set provider implementation. -**Author** -Artur Bosch - ### Constructors | [<init>](-init-.html) | `RuleSet(id: `[`RuleSetId`](../-rule-set-id.html)`, rules: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`BaseRule`](../-base-rule/index.html)`>)`
A rule set is a collection of rules and must be defined within a rule set provider implementation. | @@ -20,9 +17,10 @@ Artur Bosch ### Properties | [id](id.html) | `val id: `[`RuleSetId`](../-rule-set-id.html) | +| [pathFilters](path-filters.html) | `var pathFilters: `[`PathFilters`](../../io.gitlab.arturbosch.detekt.api.internal/-path-filters/index.html)`?`
Is used to determine if a given [KtFile](#) should be analyzed at all. | | [rules](rules.html) | `val rules: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`BaseRule`](../-base-rule/index.html)`>` | ### Functions -| [accept](accept.html) | `fun accept(file: KtFile, bindingContext: BindingContext = BindingContext.EMPTY): `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Finding`](../-finding/index.html)`>`
Visits given file with all rules of this rule set, returning a list of all code smell findings.`fun accept(file: KtFile, ruleFilters: `[`Set`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html)`<`[`RuleId`](../-rule-id.html)`>, bindingContext: BindingContext = BindingContext.EMPTY): `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Finding`](../-finding/index.html)`>`
Visits given file with all non-filtered rules of this rule set. If a rule is a [MultiRule](../-multi-rule/index.html) the filters are passed to it via a setter and later used to filter sub rules of the [MultiRule](../-multi-rule/index.html). | +| [accept](accept.html) | `fun accept(file: KtFile, bindingContext: BindingContext = BindingContext.EMPTY): `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Finding`](../-finding/index.html)`>`
Visits given file with all rules of this rule set, returning a list of all code smell findings. | diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-rule-set/path-filters.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-rule-set/path-filters.md new file mode 100644 index 000000000..822ce8653 --- /dev/null +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-rule-set/path-filters.md @@ -0,0 +1,12 @@ +--- +title: RuleSet.pathFilters - detekt-api +--- + +[detekt-api](../../index.html) / [io.gitlab.arturbosch.detekt.api](../index.html) / [RuleSet](index.html) / [pathFilters](./path-filters.html) + +# pathFilters + +`var pathFilters: `[`PathFilters`](../../io.gitlab.arturbosch.detekt.api.internal/-path-filters/index.html)`?` + +Is used to determine if a given [KtFile](#) should be analyzed at all. + diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-rule/-init-.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-rule/-init-.md index cb7249bc9..fe6e2887b 100644 --- a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-rule/-init-.md +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-rule/-init-.md @@ -16,9 +16,3 @@ A rule is implemented using the visitor pattern and should be started using the function. If calculations must be done before or after the visiting process, here are two predefined (preVisit/postVisit) functions which can be overridden to setup/teardown additional data. -**Author** -Artur Bosch - -**Author** -Marvin Ramin - diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-rule/filters.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-rule/filters.md new file mode 100644 index 000000000..65e5ae9e7 --- /dev/null +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-rule/filters.md @@ -0,0 +1,16 @@ +--- +title: Rule.filters - detekt-api +--- + +[detekt-api](../../index.html) / [io.gitlab.arturbosch.detekt.api](../index.html) / [Rule](index.html) / [filters](./filters.html) + +# filters + +`open val filters: `[`PathFilters`](../../io.gitlab.arturbosch.detekt.api.internal/-path-filters/index.html)`?` + +Rules are aware of the paths they should run on via configuration properties. + +**Getter** + +Rules are aware of the paths they should run on via configuration properties. + diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-rule/index.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-rule/index.md index d708a745c..dd0cc4e43 100644 --- a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-rule/index.md +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-rule/index.md @@ -16,12 +16,6 @@ A rule is implemented using the visitor pattern and should be started using the function. If calculations must be done before or after the visiting process, here are two predefined (preVisit/postVisit) functions which can be overridden to setup/teardown additional data. -**Author** -Artur Bosch - -**Author** -Marvin Ramin - ### Constructors | [<init>](-init-.html) | `Rule(ruleSetConfig: `[`Config`](../-config/index.html)` = Config.empty, ruleContext: `[`Context`](../-context/index.html)` = DefaultContext())`
A rule defines how one specific code structure should look like. If code is found which does not meet this structure, it is considered as harmful regarding maintainability or readability. | @@ -30,8 +24,7 @@ Marvin Ramin | [aliases](aliases.html) | `val aliases: `[`Set`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>`
List of rule ids which can optionally be used in suppress annotations to refer to this rule. | | [defaultRuleIdAliases](default-rule-id-aliases.html) | `open val defaultRuleIdAliases: `[`Set`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>`
The default names which can be used instead of this #ruleId to refer to this rule in suppression's. | -| [excludes](excludes.html) | `open val excludes: `[`Set`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html)`<`[`PathMatcher`](https://docs.oracle.com/javase/8/docs/api/java/nio/file/PathMatcher.html)`>?`
When specified this rule will not run on KtFile's having a path matching any exclusion pattern. | -| [includes](includes.html) | `open val includes: `[`Set`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html)`<`[`PathMatcher`](https://docs.oracle.com/javase/8/docs/api/java/nio/file/PathMatcher.html)`>?`
When specified this rule only runs on KtFile's with paths matching any inclusion pattern. | +| [filters](filters.html) | `open val filters: `[`PathFilters`](../../io.gitlab.arturbosch.detekt.api.internal/-path-filters/index.html)`?`
Rules are aware of the paths they should run on via configuration properties. | | [issue](issue.html) | `abstract val issue: `[`Issue`](../-issue/index.html)
A rule is motivated to point out a specific issue in the code base. | | [ruleId](rule-id.html) | `val ruleId: `[`RuleId`](../-rule-id.html)
An id this rule is identified with. Conventionally the rule id is derived from the issue id as these two classes have a coexistence. | | [ruleSetConfig](rule-set-config.html) | `open val ruleSetConfig: `[`Config`](../-config/index.html)
Wrapped configuration of the ruleSet this rule is in. Use #valueOrDefault function to retrieve properties specified for the rule implementing this interface instead. Only use this property directly if you need a specific rule set property. | diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-single-assign/-init-.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-single-assign/-init-.md index d6fc847b1..246beeba9 100644 --- a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-single-assign/-init-.md +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-single-assign/-init-.md @@ -11,6 +11,3 @@ title: SingleAssign. - detekt-api Allows to assign a property just once. Further assignments result in [IllegalStateException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-state-exception/index.html)'s. -**Author** -Artur Bosch - diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-single-assign/index.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-single-assign/index.md index df4354057..fc3de42a8 100644 --- a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-single-assign/index.md +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-single-assign/index.md @@ -11,9 +11,6 @@ title: SingleAssign - detekt-api Allows to assign a property just once. Further assignments result in [IllegalStateException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-state-exception/index.html)'s. -**Author** -Artur Bosch - ### Constructors | [<init>](-init-.html) | `SingleAssign()`
Allows to assign a property just once. Further assignments result in [IllegalStateException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-state-exception/index.html)'s. | diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-threshold-rule/index.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-threshold-rule/index.md index abbb08867..61d5528f0 100644 --- a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-threshold-rule/index.md +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-threshold-rule/index.md @@ -23,8 +23,7 @@ but can be also obtained from within a configuration object. | [aliases](../-rule/aliases.html) | `val aliases: `[`Set`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>`
List of rule ids which can optionally be used in suppress annotations to refer to this rule. | | [defaultRuleIdAliases](../-rule/default-rule-id-aliases.html) | `open val defaultRuleIdAliases: `[`Set`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>`
The default names which can be used instead of this #ruleId to refer to this rule in suppression's. | -| [excludes](../-rule/excludes.html) | `open val excludes: `[`Set`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html)`<`[`PathMatcher`](https://docs.oracle.com/javase/8/docs/api/java/nio/file/PathMatcher.html)`>?`
When specified this rule will not run on KtFile's having a path matching any exclusion pattern. | -| [includes](../-rule/includes.html) | `open val includes: `[`Set`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html)`<`[`PathMatcher`](https://docs.oracle.com/javase/8/docs/api/java/nio/file/PathMatcher.html)`>?`
When specified this rule only runs on KtFile's with paths matching any inclusion pattern. | +| [filters](../-rule/filters.html) | `open val filters: `[`PathFilters`](../../io.gitlab.arturbosch.detekt.api.internal/-path-filters/index.html)`?`
Rules are aware of the paths they should run on via configuration properties. | | [issue](../-rule/issue.html) | `abstract val issue: `[`Issue`](../-issue/index.html)
A rule is motivated to point out a specific issue in the code base. | | [ruleId](../-rule/rule-id.html) | `val ruleId: `[`RuleId`](../-rule-id.html)
An id this rule is identified with. Conventionally the rule id is derived from the issue id as these two classes have a coexistence. | | [ruleSetConfig](../-rule/rule-set-config.html) | `open val ruleSetConfig: `[`Config`](../-config/index.html)
Wrapped configuration of the ruleSet this rule is in. Use #valueOrDefault function to retrieve properties specified for the rule implementing this interface instead. Only use this property directly if you need a specific rule set property. | diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-thresholded-code-smell/-init-.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-thresholded-code-smell/-init-.md index d1f46eead..a8bece1b8 100644 --- a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-thresholded-code-smell/-init-.md +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-thresholded-code-smell/-init-.md @@ -11,3 +11,7 @@ title: ThresholdedCodeSmell. - detekt-api Represents a code smell for which a specific metric can be determined which is responsible for the existence of this rule violation. +**See Also** + +[CodeSmell](../-code-smell/index.html) + diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-thresholded-code-smell/index.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-thresholded-code-smell/index.md index 903032122..4ae1585dc 100644 --- a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-thresholded-code-smell/index.md +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-thresholded-code-smell/index.md @@ -11,6 +11,10 @@ title: ThresholdedCodeSmell - detekt-api Represents a code smell for which a specific metric can be determined which is responsible for the existence of this rule violation. +**See Also** + +[CodeSmell](../-code-smell/index.html) + ### Constructors | [<init>](-init-.html) | `ThresholdedCodeSmell(issue: `[`Issue`](../-issue/index.html)`, entity: `[`Entity`](../-entity/index.html)`, metric: `[`Metric`](../-metric/index.html)`, message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, references: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Entity`](../-entity/index.html)`> = emptyList())`
Represents a code smell for which a specific metric can be determined which is responsible for the existence of this rule violation. | diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-yaml-config/index.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-yaml-config/index.md index a487c039d..4e65a3cab 100644 --- a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-yaml-config/index.md +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-yaml-config/index.md @@ -11,11 +11,9 @@ title: YamlConfig - detekt-api Config implementation using the yaml format. SubConfigurations can return sub maps according to the yaml specification. -**Author** -Artur Bosch - ### Properties +| [parent](parent.html) | `val parent: `[`HierarchicalConfig.Parent`](../-hierarchical-config/-parent/index.html)`?`
Returns the parent config which encloses this config part. | | [properties](properties.html) | `val properties: `[`Map`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`>` | ### Functions diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-yaml-config/parent.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-yaml-config/parent.md new file mode 100644 index 000000000..275667a3b --- /dev/null +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/-yaml-config/parent.md @@ -0,0 +1,14 @@ +--- +title: YamlConfig.parent - detekt-api +--- + +[detekt-api](../../index.html) / [io.gitlab.arturbosch.detekt.api](../index.html) / [YamlConfig](index.html) / [parent](./parent.html) + +# parent + +`val parent: `[`HierarchicalConfig.Parent`](../-hierarchical-config/-parent/index.html)`?` + +Overrides [HierarchicalConfig.parent](../-hierarchical-config/parent.html) + +Returns the parent config which encloses this config part. + diff --git a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/index.md b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/index.md index f7d4d679c..d8d8407e6 100644 --- a/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/index.md +++ b/docs/pages/kdoc/detekt-api/io.gitlab.arturbosch.detekt.api/index.md @@ -9,7 +9,7 @@ title: io.gitlab.arturbosch.detekt.api - detekt-api ### Types | [AnnotationExcluder](-annotation-excluder/index.html) | `class AnnotationExcluder`
Primary use case for an AnnotationExcluder is to decide if a KtElement should be excluded from further analysis. This is done by checking if a special annotation is present over the element. | -| [BaseConfig](-base-config/index.html) | `abstract class BaseConfig : `[`Config`](-config/index.html)
Convenient base configuration which parses/casts the configuration value based on the type of the default value. | +| [BaseConfig](-base-config/index.html) | `abstract class BaseConfig : `[`HierarchicalConfig`](-hierarchical-config/index.html)
Convenient base configuration which parses/casts the configuration value based on the type of the default value. | | [BaseRule](-base-rule/index.html) | `abstract class BaseRule : `[`DetektVisitor`](-detekt-visitor/index.html)`, `[`Context`](-context/index.html)
Defines the visiting mechanism for KtFile's. | | [CodeSmell](-code-smell/index.html) | `open class CodeSmell : `[`Finding`](-finding/index.html)
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](-issue/index.html). | | [Compactable](-compactable/index.html) | `interface Compactable`
Provides a compact string representation. | @@ -18,6 +18,7 @@ title: io.gitlab.arturbosch.detekt.api - detekt-api | [ConfigAware](-config-aware/index.html) | `interface ConfigAware : `[`Config`](-config/index.html)
Interface which is implemented by each Rule class to provide utility functions to retrieve specific or generic properties from the underlying detekt configuration file. | | [ConsoleReport](-console-report/index.html) | `abstract class ConsoleReport : `[`Extension`](-extension/index.html)
Extension point which describes how findings should be printed on the console. | | [Context](-context/index.html) | `interface Context`
A context describes the storing and reporting mechanism of [Finding](-finding/index.html)'s inside a [Rule](-rule/index.html). Additionally it handles suppression and aliases management. | +| [CorrectableCodeSmell](-correctable-code-smell/index.html) | `open class CorrectableCodeSmell : `[`CodeSmell`](-code-smell/index.html)
Represents a code smell for that can be auto corrected. | | [Debt](-debt/index.html) | `data class Debt`
Debt describes the estimated amount of work needed to fix a given issue. | | [DefaultContext](-default-context/index.html) | `open class DefaultContext : `[`Context`](-context/index.html)
Default [Context](-context/index.html) implementation. | | [Detektion](-detektion/index.html) | `interface Detektion`
Storage for all kinds of findings and additional information which needs to be transferred from the detekt engine to the user. | @@ -28,6 +29,7 @@ title: io.gitlab.arturbosch.detekt.api - detekt-api | [Finding](-finding/index.html) | `interface Finding : `[`Compactable`](-compactable/index.html)`, `[`HasEntity`](-has-entity/index.html)`, `[`HasMetrics`](-has-metrics/index.html)
Base interface of detection findings. Inherits a bunch of useful behaviour from sub interfaces. | | [HasEntity](-has-entity/index.html) | `interface HasEntity`
Describes a source code position. | | [HasMetrics](-has-metrics/index.html) | `interface HasMetrics`
Adds metric container behaviour. | +| [HierarchicalConfig](-hierarchical-config/index.html) | `interface HierarchicalConfig : `[`Config`](-config/index.html)
A configuration which keeps track of the config it got sub-config'ed from by the [subConfig](-config/sub-config.html) function. It's main usage is to recreate the property-path which was taken when using the [subConfig](-config/sub-config.html) function repeatedly. | | [Issue](-issue/index.html) | `data class Issue`
An issue represents a problem in the codebase. | | [LazyRegex](-lazy-regex/index.html) | `class LazyRegex : `[`ReadOnlyProperty`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.properties/-read-only-property/index.html)`<`[`Rule`](-rule/index.html)`, `[`Regex`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.text/-regex/index.html)`>`
LazyRegex class provides a lazy evaluation of a Regex pattern for usages inside Rules. It computes the value once when reaching the point of its usage and returns the same value when requested again. | | [Location](-location/index.html) | `data class Location : `[`Compactable`](-compactable/index.html)
Specifies a position within a source code fragment. | @@ -61,11 +63,4 @@ title: io.gitlab.arturbosch.detekt.api - detekt-api ### Properties | [DEFAULT_FLOAT_CONVERSION_FACTOR](-d-e-f-a-u-l-t_-f-l-o-a-t_-c-o-n-v-e-r-s-i-o-n_-f-a-c-t-o-r.html) | `const val DEFAULT_FLOAT_CONVERSION_FACTOR: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
To represent a value of 0.5, use the metric value 50 and the conversion factor of 100. (50 / 100 = 0.5) | -| [psiFactory](psi-factory.html) | `val psiFactory: KtPsiFactory`
Allows to generate different kinds of KtElement's. | -| [psiProject](psi-project.html) | `val psiProject: Project`
The initialized kotlin environment which is used to translate kotlin code to a Kotlin-AST. | - -### Functions - -| [createCompilerConfiguration](create-compiler-configuration.html) | `fun createCompilerConfiguration(classpath: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>, pathsToAnalyze: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Path`](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html)`>): CompilerConfiguration` | -| [createKotlinCoreEnvironment](create-kotlin-core-environment.html) | `fun createKotlinCoreEnvironment(configuration: CompilerConfiguration = CompilerConfiguration()): KotlinCoreEnvironment` |