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 doxyfile for version of doxygen used by CI, turn on some settings... #81

Closed
edwardhartnett opened this issue Jul 2, 2021 · 1 comment · Fixed by #147
Closed
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@edwardhartnett
Copy link
Contributor

edwardhartnett commented Jul 2, 2021

The doxyfile is generated by cmake from docs/doxyfile.in. Variables in doxyfile.in like @Version@ are replaced with the appropriate values by cmake.

We need to:

  • learn the version of doxygen used by GitHub CI.
  • get on a machine with that exact version of doxygen (or install that version).
  • cd docs and run doxygen -u Doxyfile.in to update the Doxyfile.in file. This will add some settings and comments.
  • push changes and submit PR with new Doxyfile.in.

The end result will be an updated doxyfile.in, which includes some new fields.

See ufs-community/UFS_UTILS#418 for an example.

Then, we want to set the following:

  • set REFERENCED_BY_RELATION = YES if you want the documentation for each subprogram to include a list of which other subprograms call it
  • set REFERENCES_RELATION = YES if you want the documentation for each subprogram to include a list of which other subprograms it calls
@edwardhartnett edwardhartnett added the documentation Improvements or additions to documentation label Jul 2, 2021
@kgerheiser
Copy link
Contributor

kgerheiser commented Jul 2, 2021

Why does the Doxygen version matter, or rather why does it have to be the same version?

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

Successfully merging a pull request may close this issue.

3 participants