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

Better API documentation #4

Open
lakshayg opened this issue Jul 1, 2016 · 1 comment
Open

Better API documentation #4

lakshayg opened this issue Jul 1, 2016 · 1 comment
Labels
enhancement
Milestone
Stable API

Comments

@lakshayg
Copy link
Owner

lakshayg commented Jul 1, 2016

The current API documentation is difficult to manage as it has to be done manually. Use Sphinx/Doxygen or some other automatic documentation generator.
@lakshayg lakshayg added this to the v1.0.0 milestone Jul 1, 2016
@lakshayg
Copy link
Owner Author

lakshayg commented Jul 3, 2016

Use Doxygen unless you have a very good reason to go with alternatives. Several sorces on the web recommend Doxygen over Sphinx for C++ documentation

@lakshayg lakshayg modified the milestones: v0.2.0, Stable API Jul 6, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement
Projects
None yet
Milestone
Stable API
Development

No branches or pull requests
1 participant
@lakshayg