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

DocumentedRule

sealed class DocumentedRule<T : Finding> : ModuleCheckRule<T>

Constructors

protected fun DocumentedRule()

Types

object Companion

Functions

abstract suspend fun check(project: McProject): List<T>

abstract fun shouldApply(settings: ModuleCheckSettings): Boolean

open override fun toString(): String

Properties

abstract val description: String

documentationUrl

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.

abstract val name: FindingName

Inheritors

AnvilFactoryRule

DisableAndroidResourcesRule

DisableViewBindingRule

InheritedDependencyRule

OverShotDependencyRule

SortDependenciesRule

SortPluginsRule

UnusedDependencyRule

UnusedKaptPluginRule

UnusedKaptProcessorRule

UnusedKotlinAndroidExtensionsRule

Sources