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

[FEAT] Doxygen for in-code documentation #9

Open
qalshidi opened this issue Nov 11, 2020 · 0 comments
Open

[FEAT] Doxygen for in-code documentation #9

qalshidi opened this issue Nov 11, 2020 · 0 comments
Assignees
@qalshidi
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@qalshidi
Copy link
Contributor

Is your feature request related to a problem? Please describe.

We can use automatic documentation with
Doxygen which is common for C++
specifically.

Describe the solution you'd like

Start documenting code in the .h files with Doxygen

Describe alternatives you've considered

Sphinx, which is popular with Python but I have not seen it used in C++ before.
@qalshidi qalshidi added the enhancement New feature or request label Nov 11, 2020
@qalshidi qalshidi self-assigned this Nov 11, 2020
@qalshidi qalshidi mentioned this issue Nov 11, 2020
Closed
6 tasks
@aaronjridley aaronjridley added the documentation Improvements or additions to documentation label Dec 11, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@qalshidi qalshidi

Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@aaronjridley @qalshidi