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

Lots of places lack full documentation #11

Open
HopeBaron opened this issue Jun 16, 2020 · 0 comments · May be fixed by #729
Open

Lots of places lack full documentation #11

HopeBaron opened this issue Jun 16, 2020 · 0 comments · May be fixed by #729
Labels
documentation Improvements or additions to documentation

Comments

@HopeBaron
Copy link
Member

HopeBaron commented Jun 16, 2020 •
edited

Summary

Currently the project lacks full documentation with description and informative block tags in lots of places.

Goal

I open this issue with the intent of starting to fully document the whole project, little by little.

Motivation

Documentation is key to allow developers to explore the library on their own making it easier and faster to write better code.

Relevant resources

Documenting Kotlin Code
Dokka

/label ~Enhancement

**Issue originally posted by @Tmpod
@BartArys BartArys added the documentation Improvements or additions to documentation label Aug 25, 2020
@NoComment1105 NoComment1105 linked a pull request Nov 21, 2022 that will close this issue
Draft
35 tasks
@DRSchlaubi DRSchlaubi mentioned this issue Jul 15, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Kdoc the Kord NoComment1105/kord
2 participants
@BartArys @HopeBaron