Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Introduce a linter for KDoc tags #3646

Open
vmishenev opened this issue Jun 12, 2024 · 0 comments
Open

Introduce a linter for KDoc tags #3646

vmishenev opened this issue Jun 12, 2024 · 0 comments
Labels
enhancement An issue for a feature or an overall improvement kdoc-spec An issue that requires clarification from the KDoc spec's perspective

Comments

@vmishenev
Copy link
Member

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 #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() {}
@vmishenev vmishenev added enhancement An issue for a feature or an overall improvement kdoc-spec An issue that requires clarification from the KDoc spec's perspective labels Jun 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement An issue for a feature or an overall improvement kdoc-spec An issue that requires clarification from the KDoc spec's perspective
Projects
None yet
Development

No branches or pull requests

1 participant