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

Code Documentation Improvements #24

Open
cretz opened this issue Oct 11, 2018 · 1 comment
Open

Code Documentation Improvements #24

cretz opened this issue Oct 11, 2018 · 1 comment

Comments

@cretz
Copy link
Owner

cretz commented Oct 11, 2018

Once #23 is done, we need to:

  • Update README to give more details to programmatic users
  • Add KDoc to more of the lib
  • Publish a dokka javadoc jar to maven central w/ next release
  • Update README to remove some of the less-called CLI stuff
@cretz cretz changed the title Documentation Improvements Code Documentation Improvements Oct 16, 2018
@cretz
Copy link
Owner Author

cretz commented Oct 16, 2018

Dokka is in a poor state right now (hopefully will get better). It takes many minutes to build the docs for this project, and they don't even link to external docs right now. I'm just gonna clean up the README for now and leave this open for code docs to revisit once the situation improves.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@cretz