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.

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

Update Doxygen documentation #146

Closed
smpark7 opened this issue Jan 19, 2021 · 4 comments · Fixed by #148
Closed

Update Doxygen documentation #146

smpark7 opened this issue Jan 19, 2021 · 4 comments · Fixed by #148

Comments

@smpark7
Copy link
Collaborator

smpark7 commented Jan 19, 2021

This issue can be closed when the Doxygen documentation in Moltres is updated to reflect the latest Moltres build.

The goal is to update the Doxygen generated html files for arfc.github.io/moltres, which were last compiled in 2017, so that the latest kernels and other objects are accounted for.

This is separate from (but somewhat related to) issue #133, which highlights missing docstrings for functions and variables in .h files. Ideally, we would close #133 before closing this issue.

@smpark7
Copy link
Collaborator Author

smpark7 commented Jan 19, 2021

@yardasol How's the progress with #133? I was thinking of just updating the Doxygen files first and then running another update after #133 is resolved

@yardasol
Copy link
Contributor

@smpark7 I started a list of files back in October in order to determine which ones needed attention. Most of it is not currently filled out.

@yardasol
Copy link
Contributor

@smpark7 Are you updating the existing doxygen files or are you adding new ones as well?

@smpark7
Copy link
Collaborator Author

smpark7 commented Jan 19, 2021

Both. Doxygen updates existing files if there are any changes, and creates new ones for kernels/objects that didn't exist before. I'll go ahead and make a PR because a Doxygen update is long overdue. We can update it again whenever needed

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

Successfully merging a pull request may close this issue.

2 participants