modulecheck-rule:impl/modulecheck.rule.impl/DocumentedRule

DocumentedRule

sealed class DocumentedRule<T : Finding> : ModuleCheckRule<T> (source)

Inheritors

Constructors

Link copied to clipboard
protected constructor()

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
abstract val description: String
Link copied to clipboard
override val documentationUrl: String

This should correspond to the finding name in snake_case. So a rule with a findingName.id of 'unused-dependency' would have a documentation url of <docs root>/rules/unused_dependency.

Link copied to clipboard
abstract val name: FindingName

Functions

Link copied to clipboard
abstract suspend fun check(project: McProject): List<T>
Link copied to clipboard
abstract fun shouldApply(settings: ModuleCheckSettings): Boolean
Link copied to clipboard
open override fun toString(): String