modulecheck-rule:impl/modulecheck.rule.impl/MustBeApiRule

MustBeApiRule

class MustBeApiRule @Inject constructor : DocumentedRule<MustBeApiFinding> (source)

Constructors

MustBeApiRule

@Inject

constructor()

Properties

description

open override 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.

name

open override val name: FindingName

Functions

check

open suspend override fun check(project: McProject): List<MustBeApiFinding>

shouldApply

open override fun shouldApply(settings: ModuleCheckSettings): Boolean

toString

open override fun toString(): String