jlengrand/detekt
1
0
Fork 0
mirror of https://github.com/jlengrand/detekt.git synced 2026-03-10 08:11:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve description of AbsentOrWrongFileLicense rule (#3109)

Browse Source 
* Improve description of AbsentOrWrongFileLicense rule

The new description states how the rule checks Kotlin source files
against the given license header.
Closes #3100

* Update grammar in description

* Regenerate docs
This commit is contained in:
M Schalk
2020-09-27 16:26:38 +02:00
committed by GitHub
parent d3b1915732
commit e852dbc521
2 changed files with 6 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
detekt-rules-documentation/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/documentation/AbsentOrWrongFileLicense.kt
View File

@@ -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'`)

4
docs/pages/documentation/comments.md
View File

@@ -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