diff --git a/detekt-rules-documentation/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/documentation/AbsentOrWrongFileLicense.kt b/detekt-rules-documentation/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/documentation/AbsentOrWrongFileLicense.kt index fc6335430..e658c3081 100644 --- a/detekt-rules-documentation/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/documentation/AbsentOrWrongFileLicense.kt +++ b/detekt-rules-documentation/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/documentation/AbsentOrWrongFileLicense.kt @@ -10,7 +10,9 @@ import io.gitlab.arturbosch.detekt.api.Severity import org.jetbrains.kotlin.psi.KtFile /** - * This rule will report every Kotlin source file which doesn't have required license header. + * This rule will report every Kotlin source file which doesn't have the required license header. + * The rule checks each Kotlin source file whether the header starts with the read text from the passed file in the + * `licenseTemplateFile` configuration option. * * @configuration licenseTemplateFile - path to file with license header template resolved relatively to config file * (default: `'license.template'`) diff --git a/docs/pages/documentation/comments.md b/docs/pages/documentation/comments.md index abe7f022c..5b64e52b6 100644 --- a/docs/pages/documentation/comments.md +++ b/docs/pages/documentation/comments.md @@ -11,7 +11,9 @@ of the code. ### AbsentOrWrongFileLicense -This rule will report every Kotlin source file which doesn't have required license header. +This rule will report every Kotlin source file which doesn't have the required license header. +The rule checks each Kotlin source file whether the header starts with the read text from the passed file in the +`licenseTemplateFile` configuration option. **Severity**: Maintainability