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.

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

Documentation #34

Open
jonblack opened this issue Jun 2, 2016 · 2 comments
Open

Documentation #34

jonblack opened this issue Jun 2, 2016 · 2 comments

Comments

@jonblack
Copy link
Owner

jonblack commented Jun 2, 2016

The library is getting a little more complex and the examples probably won't be enough to help newcomers.

Write some documentation and stick it up on readthedocs.org

@eadf
Copy link
Contributor

eadf commented Jun 2, 2016

How about first adding documentation of each method in the header file?
The header file is, after all, the first place where we usually look for API documentation.

If the header file has, for example, doxygen comments the generated files can be used as a base for higher level documentation at third-party sites.

@jonblack
Copy link
Owner Author

jonblack commented Jun 3, 2016

I've started added some doxygen style comments already. But you're right, that should be done here as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants