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

Consider using Doxygen for code documentation #55

Open
i-ky opened this issue Sep 27, 2018 · 0 comments
Open

Consider using Doxygen for code documentation #55

i-ky opened this issue Sep 27, 2018 · 0 comments

Comments

@i-ky
Copy link
Collaborator

i-ky commented Sep 27, 2018

Doxygen can automatically generate HTML documentation of source code based on comments of a specific format. Docs can be generated locally for any branch you are currently working on and it is even possible to use Travis CI to automatically generate docs for master branch and publish it in GitHub Pages like described here and here. This should make life of potential contributors substantially easier.

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

No branches or pull requests

1 participant