jameskermode / f90wrap

F90 to Python interface generator with derived type support

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Can `f90wrap`parse FORD docstrings?

HugoMVale opened this issue · comments

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