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

[FEATURE] Improve C++ code documentation #96

Open

petersalemink95 opened this issue Jul 13, 2022 · 0 comments

Labels

documentation good first issue

Member

petersalemink95 commented Jul 13, 2022 •

edited by TonyXiang8787

Loading

To make the C++ code easier to understand it would be nice to improve the code documentation.

Tasks:

Choose 1 style for code documentation and adjust all documentation to this style
Make sure the functions contain a clear explanation of the logic, the input arguments and the return type
Write some markdown documentation for developers about philosophical design choices.

petersalemink95 changed the title ~~[FEATURE] Improve code documentation~~ [FEATURE] Improve C++ code documentation

TonyXiang8787 added the documentation label

mgovers added the good first issue label

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