You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
The text was updated successfully, but these errors were encountered:
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.
The text was updated successfully, but these errors were encountered: