Skip to content
This repository was archived by the owner on Apr 6, 2020. It is now read-only.
This repository was archived by the owner on Apr 6, 2020. It is now read-only.

Code Comments for KDoc (equivalent of Java's JavaDoc) #8

Description

@jumaallan

Code readability.
As the code base grows, we need to make sure its properly documented so as to make it easy for users to understand what the code does, args needs, what it returns and why

Solution
Make sure all methods are properly commented, to make documentation easy.

Additional context
We might need to have a CI which performs this check, not sure. Open to ideas

Metadata

Metadata

Labels

documentationImprovements or additions to documentation

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions