Fortran-FOSS-Programmers / Fortran-FOSS-Programmers/ford
Documentation for a group of variables
- Dominant language
- Python
- Stars
- 458
- Forks
- 138
- PR merge metrics
- No merged PRs in 30d
Description
With Doxygen, it is possible to create a grouping of variables (and subroutines, types, etc) and give documentation for all of them as a whole. Example of what I mean:
```
!> \name Huygens surface existence
!! These variables specify if correction terms should be applied in this block
!! at a given side for a given field.
!>\{
logical :: xlo_e = .false., xlo_h = .false., xhi_e = .false., xhi_h = .false.
logical :: ylo_e = .false., ylo_h = .false., yhi_e = .false., yhi_h = .false.
logical :: zlo_e = .false., zlo_h = .false., zhi_e = .false., zhi_h = .false.
!>\}
```
Doxygen creates a section for it:

I cannot find a comparable feature in FORD. When the number of variables is large and the same documentation applies to all, duplication is not attractive.
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.