Bring Doxygen comment blocks up to spec.
Open
@andrewcoughtrie is already working on this.
Since Aug 27, 2024.
- Dominant language
- C++
- Stars
- 6
- Forks
- 11
- Avg merge
- 18h 7m
- Merged PRs (30d)
- 1
Description
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.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.