Skip to content
This repository has been archived by the owner on Jul 28, 2021. It is now read-only.

[codestyle] Clean up, and normalize KDoc Comments #141

Closed
junlarsen opened this issue Jul 15, 2020 · 0 comments
Closed

[codestyle] Clean up, and normalize KDoc Comments #141

junlarsen opened this issue Jul 15, 2020 · 0 comments
Labels
type:invalid This doesn't seem right

Comments

@junlarsen
Copy link
Owner

Many different KDocs have different styles and different content. These should be consistent across the entire project.

  • Any TODO items are appended at the end of the KDoc
  • @see tags are the final item in the KDoc, apart from TODOs
  • Documentation links should be in Markdown
@junlarsen junlarsen added the good first issue This is a nice issue for contributors to start contributing label Jul 15, 2020
@junlarsen junlarsen added type:invalid This doesn't seem right and removed good first issue This is a nice issue for contributors to start contributing labels Oct 4, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
type:invalid This doesn't seem right
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@junlarsen