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

Can f90wrapparse FORD docstrings? #196

Open
HugoMVale opened this issue Jun 12, 2023 · 0 comments
Open

Can f90wrapparse FORD docstrings? #196

HugoMVale opened this issue Jun 12, 2023 · 0 comments

Comments

@HugoMVale
Copy link

According to the documentation, f90wrap can parse Doxygen docstrings.
Can it also (and if so, how) parse FORD-style docstrings? Example below for illustration.
Thank you.

 pure real(rk) function lax_friedrichs(f, vm, vp, x, t, alpha) result(res)
  !!   Monotone Lax-Friedrichs flux. It is more dissipative than the Godunov method, but
  !! computationally less demanding.
  !!   Source: Equation 2.72, page 21.
    procedure(flux) :: f
      !! flux function, \( f(v, x, t) \)
    real(rk), intent(in) :: vm
      !! left (minus) reconstruction, \( v_{i+1/2}^- \)
    real(rk), intent(in) :: vp
      !! right (plus) reconstruction, \( v_{i+1/2}^+ = v_{(i+1)-1/2}^- \)
    real(rk), intent(in) :: x(:)
      !! \(x\) at flux interface, \( x_{i+1/2} \)
    real(rk), intent(in) :: t
      !! time, \( t \)
    real(rk), intent(in) :: alpha
      !! \( \max(|f'(v)|) \) in the domain on the problem

    res = (f(vm, x, t) + f(vp, x, t) - alpha*(vp - vm))/2

 end function lax_friedrichs 
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant