adflow icon indicating copy to clipboard operation
adflow copied to clipboard

Progressively add Doxygen doc strings to adflow's fortran routines

Open joanibal opened this issue 3 years ago • 1 comments

Description

As discussed in the maintenance meeting, adding doc strings to the Fortran subroutines would greatly improve the readability of the low-level code.

The comments will use Doxygen formatting so that we can compile them into additional documentation for Adflow.

The initial though was to do a progressive roll out since the code base is so large. To accomplish this the maintainers are responsible for making sure that when someone edits an existing Fortran function in Adflow, they also add a doc string.

joanibal avatar Feb 28 '22 15:02 joanibal

How good is the Fortran support in Doxygen? There is also FORD which is being used by several modern Fortran projects, but I hesitate to recommend it since I don't think it provides other features from Doxygen such as the call graphs.

ewu63 avatar Feb 28 '22 15:02 ewu63