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

Setup documentation #2

Open
4 tasks
taminob opened this issue Mar 18, 2024 · 0 comments
Open
4 tasks

Setup documentation #2

taminob opened this issue Mar 18, 2024 · 0 comments
Labels
cmake Related to cmake build system documentation Improvements or additions to documentation enhancement New feature or request

Comments

@taminob
Copy link
Owner

taminob commented Mar 18, 2024

To maintain an up-to-date documentation, it should be close to the code.
For this, doxygen comments probably make the most sense.

The goal should be:

  • Add documentation to every (public) interface class and method
  • Setup doxygen generation via cmake
  • Create CI to generate documentation
  • Host documentation on Github
@taminob taminob added documentation Improvements or additions to documentation enhancement New feature or request cmake Related to cmake build system labels Mar 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
cmake Related to cmake build system documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@taminob