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

Document energy functions #22

Open
andymina opened this issue Oct 9, 2022 · 1 comment
Open

Document energy functions #22

andymina opened this issue Oct 9, 2022 · 1 comment
Labels
docs Improvements or additions to documentation
Milestone
Generate document...

Comments

@andymina
Copy link
Owner

andymina commented Oct 9, 2022

After they've been cleaned up in #15, the functions in energy.cpp should be overhauled with proper documentation as while. It's not necessary yet to generate the "pretty" documentation, but functions should at least be documented according to Doxygen standards.
@andymina andymina added the docs Improvements or additions to documentation label Oct 9, 2022
@andymina andymina changed the title Document functions within energy.cpp Document energy functions Oct 11, 2022
@andymina
Copy link
Owner Author

#15 has been addressed so this issue can be moved along

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs Improvements or additions to documentation
Projects
None yet
Milestone
Generate documentation with Doxygen
Development

No branches or pull requests
1 participant
@andymina