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

Bring Doxygen comment blocks up to spec. #38

Open
mo-mglover opened this issue Aug 3, 2022 · 0 comments
Open

Bring Doxygen comment blocks up to spec. #38

mo-mglover opened this issue Aug 3, 2022 · 0 comments
Assignees

Comments

@mo-mglover
Copy link
Collaborator

mo-mglover commented Aug 3, 2022

Most functions have a placeholder comment block, readable by doxygen. They - for the most part - only contain @brief tags. There is no explicit description of arguments yet.

Moreover, it's not immediately clear that the Fortran support is usable alongside C++ in the same project. Ideally, the Fortran interface source files would be instrumented, too. I put some test documentation into profiler_mod, but it didn't seem to appear in the Doxygen output; I'm not sure that the Doxygen Fortran support is yet capable of recognising comments on interface blocks.

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

No branches or pull requests

2 participants