Add new rule for disallowing KDoc at non-whitelisted locations - Githubissues

pinterest / ktlint

An anti-bikeshedding Kotlin linter with built-in formatter

https://pinterest.github.io/ktlint/

MIT License

6.19k stars 505 forks source link

Add new rule for disallowing KDoc at non-whitelisted locations #2548

Closed paul-dingemans closed 7 months ago

paul-dingemans commented 7 months ago

Description

KDocs should only be used at locations for which it makes sense to provide (e.g. generate) documentation to be used by other consumers.

Closes #2547

Checklist

Before submitting the PR, please check following (checks which are not relevant may be ignored):

[X] Commit message are well written. In addition to a short title, the commit message also explain why a change is made.
[X] At least one commit message contains a reference Closes #<xxx> or Fixes #<xxx> (replace<xxx> with issue number)
[X] Tests are added
[X] KtLint format has been applied on source code itself and violations are fixed
[X] PR title is short and clear (it is used as description in the release changelog)
[X] PR description added (background information)

Documentation is updated. See difference between snapshot and release documentation

[x] Snapshot documentation in case documentation is to be released together with a code change
[ ] Release documentation in case documentation is related to a released version of ktlint and has to be published as soon as the change is merged to master