dokka
dokka copied to clipboard
Introduce a linter for KDoc tags
Dokka does not check using KDoc tags. For example,
/**
* @receiver it makes no sense for the documentation of class
*/
class A
There is no warning here in IDE and Dokka.
Expected behaviour Dokka and IDE print a warning or error. It may also solve https://github.com/Kotlin/dokka/issues/3348.
Java has such checks in IDEA and javadoc. See Javadoc specification https://docs.oracle.com/en/java/javase/22/docs/specs/javadoc/doc-comment-spec.html#where-tags-can-be-used For example,
/**
* @return this is a style error since f is void
*/
void f() {}