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

Improve documentation of functions #4

Open
EdmundGoodman opened this issue Jan 29, 2024 · 0 comments · May be fixed by #5
Open

Improve documentation of functions #4

EdmundGoodman opened this issue Jan 29, 2024 · 0 comments · May be fixed by #5

Comments

@EdmundGoodman
Copy link

Currently, only some functions in the mini-app have documentation in the form of code comments, and this documentation is not in a standard format. It would be helpful for newcomers to the codebase to have such documentation.

Ideally, all functions should have documentation, in a standard style for C++ such as Doxygen.
@EdmundGoodman EdmundGoodman linked a pull request Jan 29, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add documentation for functions EdmundGoodman/HPCCG
1 participant
@EdmundGoodman