Skip to content
This repository has been archived by the owner on Feb 23, 2018. It is now read-only.

Documentation of the external API. #12

Open
skyem123 opened this issue Aug 14, 2015 · 2 comments
Open

Documentation of the external API. #12

skyem123 opened this issue Aug 14, 2015 · 2 comments

Comments

@skyem123
Copy link
Owner

This is very important for a library, and it will also be good to have tutorials in this repo.

_Note that this issue will not be closed, as it is an important reminder to new code written_

@skyem123
Copy link
Owner Author

Internal documentation is useful, but not needed, so it will go into issue #13 .
Documentation of the external API is important, so that is what this issue will focus on.

@skyem123 skyem123 changed the title JavaDoc! Documentation of the external API. Aug 15, 2015
@skyem123
Copy link
Owner Author

Sadly, KDoc doesn't compile for me, and Dokka requires extra setup on the computer.
However, I can do some markdown documentation in this repository.

@skyem123 skyem123 added this to the First Alpha (0.1) milestone Aug 16, 2015
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

1 participant