forked from detekt/detekt
-
Notifications
You must be signed in to change notification settings - Fork 0
/
CommentSmellProvider.kt
31 lines (27 loc) · 1.03 KB
/
CommentSmellProvider.kt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
package io.gitlab.arturbosch.detekt.rules.documentation
import io.gitlab.arturbosch.detekt.api.Config
import io.gitlab.arturbosch.detekt.api.RuleSet
import io.gitlab.arturbosch.detekt.api.internal.ActiveByDefault
import io.gitlab.arturbosch.detekt.api.internal.DefaultRuleSetProvider
/**
* This rule set provides rules that address issues in comments and documentation
* of the code.
*/
@ActiveByDefault(since = "1.0.0")
class CommentSmellProvider : DefaultRuleSetProvider {
override val ruleSetId: String = "comments"
override fun instance(config: Config): RuleSet = RuleSet(
ruleSetId,
listOf(
CommentOverPrivateFunction(config),
CommentOverPrivateProperty(config),
KDocStyle(config),
OutdatedDocumentation(config),
UndocumentedPublicClass(config),
UndocumentedPublicFunction(config),
UndocumentedPublicProperty(config),
AbsentOrWrongFileLicense(config),
KDocReferencesNonPublicProperty(config)
)
)
}