Comment on page
Library Snippets
@Test
fun `every api declaration has KDoc`() {
Konsist
.scopeFromPackage("..api..")
.declarationsOf<KoKDocProvider>()
.assertTrue { it.hasKDoc }
}
@Test
fun `every function with parameters has a param tags`() {
Konsist.scopeFromPackage("..api..")
.functions()
.assertTrue { it.hasValidKDocParamTags() }
}
@Test
fun `every function with return value has a return tag`() {
Konsist.scopeFromPackage("..api..")
.functions()
.assertTrue { it.hasValidKDocReturnTag() }
}
@Test
fun `every extension has a receiver tag`() {
Konsist.scopeFromPackage("..api..")
.declarationsOf<KoReceiverTypeProvider>()
.assertTrue { it.hasValidKDocReceiverTag() }
}
@Test
fun `every public function in api package must have explicit return type`() {
Konsist
.scopeFromPackage("..api..")
.functions()
.assertTrue { it.hasReturnType() }
}
@Test
fun `every public property in api package must have specify type explicitly`() {
Konsist
.scopeFromPackage("..api..")
.properties()
.assertTrue { it.hasType() }
}
Last modified 1mo ago