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

Configure browsable documentation #5

Closed
apike opened this issue Dec 23, 2016 · 2 comments
Closed

Configure browsable documentation #5

apike opened this issue Dec 23, 2016 · 2 comments
Assignees
@sakuraehikaru

Comments

@apike
Copy link
Member

apike commented Dec 23, 2016

We should pick a popular/simple/helpful tool for generating simple API documentation out of our swift code with annotation from our comments.
@apike apike mentioned this issue Dec 23, 2016
Closed
@sakuraehikaru sakuraehikaru self-assigned this Jan 9, 2017
@sakuraehikaru sakuraehikaru mentioned this issue Jan 17, 2017
Closed
@apike
Copy link
Member Author

apike commented Feb 20, 2017

As I understand it we have some inline documentation now, we just need to set up a tool such as Jazzy that can pull out the documentation comments and turn them into docs that we can link to.

@apike apike changed the title Set up documentation Configure browsable documentation Feb 20, 2017
@sakuraehikaru
Copy link
Member

https://steamclock.github.io/bluejay/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sakuraehikaru sakuraehikaru

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@apike @sakuraehikaru