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

Useful documentation #67

Open

2 of 6 tasks

noah1510 opened this issue Aug 24, 2020 · 1 comment

Contributor

noah1510 commented Aug 24, 2020 •

edited by h4tr3d

Loading

One of the most important things is missing at the moment and that is some at least half decent documentation.

Here are a few suggestions on what should be done, feel free to propose additions in the comments:

adding a doxyfile to build html documentation (initial doxyfile #69)
build and publish the documentation to github pages or something different (github actions or maybe travis)
document all functions (javadoc style)
document every type, enum and class (javadoc style)
properly document the examples
write some kind of getting started/beginners guide

noah1510 mentioned this issue

initial doxyfile #69

Merged

Owner

h4tr3d commented Sep 7, 2020

I recreate gh-pages branch, make it with clean history.

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