Skip to content
New issue

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

#

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

Already on GitHub? # to your account

Jump to bottom

KDoc should be restricted to certain locations #2547

Closed
paul-dingemans opened this issue Feb 11, 2024 · 0 comments · Fixed by #2548
Closed

KDoc should be restricted to certain locations #2547

paul-dingemans opened this issue Feb 11, 2024 · 0 comments · Fixed by #2548
Labels
new rule

Comments

@paul-dingemans
Copy link
Collaborator

Several rules now check whether KDoc's are provided at an unexpected location. This should be centralized in a new rule.
paul-dingemans added a commit that referenced this issue Feb 11, 2024
@paul-dingemans
Add new rule for disallowing KDoc at non-whitelisted locations
21ec51f 
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
@paul-dingemans paul-dingemans mentioned this issue Feb 11, 2024
Merged
8 tasks
paul-dingemans added a commit that referenced this issue Feb 11, 2024
@paul-dingemans
Add new rule for disallowing KDoc at non-whitelisted locations (#2548)
7501f72 
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
paul-dingemans added a commit that referenced this issue Feb 11, 2024
@paul-dingemans
Remove logic which was moved to new rule 'kdoc'.
4100055 
Relates #2547
@paul-dingemans paul-dingemans mentioned this issue Feb 11, 2024
Merged
8 tasks
paul-dingemans added a commit that referenced this issue Feb 13, 2024
@paul-dingemans
Remove logic which was moved to new rule 'kdoc'. (#2549)
22ba7c1 
Relates #2547
# for free to join this conversation on GitHub. Already have an account? # to comment
Assignees
No one assigned
Labels
new rule
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add new rule for disallowing KDoc at non-whitelisted locations pinterest/ktlint
1 participant
@paul-dingemans