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

Set up doxygen for ERF #165

Closed
2 tasks
dwillcox opened this issue Nov 3, 2021 · 2 comments
Closed
2 tasks

Set up doxygen for ERF #165

dwillcox opened this issue Nov 3, 2021 · 2 comments
Assignees
@etpalmer63

Comments

@dwillcox
Copy link
Contributor

dwillcox commented Nov 3, 2021

  • get doxygen running and integrated with our online docs (Erik Palmer can do this)
  • go through ERF and add proper docstrings to all our functions
@etpalmer63 etpalmer63 linked a pull request Nov 8, 2021 that will close this issue
Doxygen startup #171
Merged
@etpalmer63 etpalmer63 removed a link to a pull request Nov 8, 2021
Doxygen startup #171
Merged
@etpalmer63 etpalmer63 self-assigned this Nov 8, 2021
@etpalmer63
Copy link
Contributor

etpalmer63 commented Nov 8, 2021 •
edited
Loading

Still working on the website update on push. PR #171 makes some changes to Doxygen output configuration (which can be changed according to preference). I was also able to modify some comments in the code to better make use of Doxygen's features.

The structure of the file: Source/RK3/RK3.H would make it a good Doxygen example if it were fully documented.

@pratikvn pratikvn mentioned this issue Apr 2, 2023
Closed
@asalmgren
Copy link
Collaborator

Doxygen has been set up for ERF and we are adding annotation. Closing this now.

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

@etpalmer63 etpalmer63

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@dwillcox @asalmgren @etpalmer63