Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Progressively add Doxygen doc strings to adflow's fortran routines #194

Open
joanibal opened this issue Feb 28, 2022 · 1 comment
Open
Labels
enhancement New feature or request

Comments

@joanibal
Copy link
Collaborator

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 joanibal added the enhancement New feature or request label Feb 28, 2022
@ewu63
Copy link
Collaborator

ewu63 commented Feb 28, 2022

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants