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

Feature request: documentation for list of variables

Open
#224 3 comments 2 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
458
Forks
138
PR merge metrics
No merged PRs in 30d

Description

Given Fortran's style of variable declaration, it is common to see (and write) variable or, more importantly, dummy argument declarations as

```fortran
REAL(8), DIMENSION(:) :: X, Y, Z
```

Right now to document `X`, `Y` and `Z` I need to repeat `REAL(8), DIMENSION(:)` part as in

```fortran
REAL(8), DIMENSION(:) :: X
!! X docs
REAL(8), DIMENSION(:) :: Y
!! Y docs
REAL(8), DIMENSION(:) :: Z
!! Z docs
```

I would like to have it a bit more like in Doxygen with, say `param:` tag (at least for dummy arguments):

```fortran
REAL(8), DIMENSION(:) :: X, Y, Z
!! param: X Docs for X
!! param: Y Docs for Y
!! param: Z Docs for Z
```

I am not sure if that kind of tag is possible though.

Similarly, for fields in `TYPE` declaration (BTW, Doxygen cannot do this):

```fortran
TYPE FOO
REAL(8) :: X, Y, Z
!! param: X Doc for X
!! ....
END TYPE
```

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.