Fortran-FOSS-Programmers / Fortran-FOSS-Programmers/ford

Module/submodule procedure's description not showing in FORD's Procedures webpage Description field

Open
#502 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
458
Forks
138
PR merge metrics
No merged PRs in 30d

Description

I'm dealing here with procedures defined in a module interface, but with their body code given in a submodule. I'm experiencing a quirk with where these procedure's autodoc comments are displayed in the FORD-generated doc.

Initially, I only had the procedure headers autodoc commented in the submodule. However, FORD doesn't seem to display FORD Procedures webpage entries for procedures in submodules (thereby, doesn't display those procedure header's autodoc comments), but does display ones for their interface definitions in the module. Not what I wanted, but I dutifully moved my submodule procedure header autodoc comments over to their equivalent interface definitions in the module. However, while these autodoc comments now show up on the individual procedure's interface webpage, they don't show up in the FORD Procedures webpage Description column even though the procedure's interface is listed there.
```
a_routine a_module Interface
```
So, this means that the procedure's header's autodoc comment can only be seen when looking at its procedure interface webpage.
```
module a_module
interface
!> a_routine interface entry comment
module subroutine a_routine(int_value)
integer, intent(in) :: int_value
end subroutine a_routine
end interface
end module a_module
---
SEPARATE submodule file
!> a_routine submodule
submodule (a_module) a_routine_submod
contains
!> a_routine submodule entry comment
module procedure a_routine
write (*,*) "a_routine:", int_value
end procedure a_routine
end submodule a_routine_submod

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.