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.

Sign up for GitHub

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

Jump to bottom

Confusing warning message in KDOC_NO_CONSTRUCTOR_PROPERTY #475

Closed
petertrr opened this issue Nov 2, 2020 · 0 comments · Fixed by #497
Closed

Confusing warning message in KDOC_NO_CONSTRUCTOR_PROPERTY #475

petertrr opened this issue Nov 2, 2020 · 0 comments · Fixed by #497
Assignees
@kentr0w
Labels
bug Something isn't working

Comments

@petertrr
Copy link
Member

petertrr commented Nov 2, 2020

For code like

data class StargazersListJson(val list: List<StargazersJson>)

warning says

ApiJson.kt:16:22: [KDOC_NO_CONSTRUCTOR_PROPERTY] replace comment before property with @property tag in KDoc: add <fullName> to KDoc

But there is no comment before property, the property is public and therefore needs to be documented. We should fix this message text.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@kentr0w kentr0w

Labels
bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Confusing warning message in KDOC_NO_CONSTRUCTOR_PROPERTY saveourtool/diktat
2 participants
@petertrr @kentr0w