Documentation of the Codebase

[simonnepinto]

Related Issue or bug

Fixes: #6

Describe the changes you've made

Added comments to all the Kotlin files explaining what each function does

Type of change

Please delete options that are not relevant.

• [x] Code style update (formatting, local variables)

Describe if there is any unusual behavior of your code(Write NA if there isn't)

NA

Checklist:

• [x] My code follows the style guidelines of this project.
• [x] I have performed a self-review of my own code.
• [x] I have commented my code, particularly in hard-to-understand areas.
• [x] I have made corresponding changes to the documentation.
• [x] My changes generate no new warnings.
• [ ] I have added tests that prove my fix is effective or that my feature works.
• [ ] New and existing unit tests pass locally with my changes.
• [x] Any dependent changes have been merged and published in downstream modules.