From 3e10baeb0ec054fcce4a88e0d05a339da602defc Mon Sep 17 00:00:00 2001 From: Jacob Williams Date: Fri, 5 Jan 2024 22:16:25 -0600 Subject: [PATCH] updated ford docs --- .github/workflows/CI.yml | 2 +- quadpack.md => ford.md | 11 +++++------ src/quadpack_generic.F90 | 4 ++-- 3 files changed, 8 insertions(+), 9 deletions(-) rename quadpack.md => ford.md (73%) diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml index 5f4f864..7c1a7a5 100644 --- a/.github/workflows/CI.yml +++ b/.github/workflows/CI.yml @@ -76,7 +76,7 @@ jobs: files: build/coverage/coverage.info - name: Build documentation - run: ford ./quadpack.md + run: ford ./ford.md - name: Deploy Documentation if: github.ref == 'refs/heads/master' diff --git a/quadpack.md b/ford.md similarity index 73% rename from quadpack.md rename to ford.md index 9cb0840..a38021f 100644 --- a/quadpack.md +++ b/ford.md @@ -1,5 +1,5 @@ project: quadpack -project_dir: ./src +src_dir: ./src output_dir: ./doc media_dir: ./media project_github: https://github.com/jacobwilliams/quadpack @@ -13,11 +13,10 @@ docmark: ! display: public source: true graph: true -exclude_dir: ./tests -exclude: quadpack_single.F90 - quadpack_double.F90 - quadpack_quad.F90 - quadpack.F90 +exclude: **/quadpack_single.F90 + **/quadpack_double.F90 + **/quadpack_quad.F90 + **/quadpack.F90 extra_mods: iso_fortran_env:https://gcc.gnu.org/onlinedocs/gfortran/ISO_005fFORTRAN_005fENV.html {!README.md!} \ No newline at end of file diff --git a/src/quadpack_generic.F90 b/src/quadpack_generic.F90 index b09d6ee..b449c25 100644 --- a/src/quadpack_generic.F90 +++ b/src/quadpack_generic.F90 @@ -7044,8 +7044,8 @@ subroutine dgtsl(n, c, d, e, b, info) real(wp), intent(inout) :: e(n) !! the superdiagonal of the tridiagonal matrix. !! `e(1)` through `e(n-1)` should contain the superdiagonal. !! on output `e` is destroyed. - real(wp), intent(inout) :: b(n) !! input: is the right hand side vector.. - !! output: the solution vector. + real(wp), intent(inout) :: b(n) !! * input: is the right hand side vector.. + !! * output: the solution vector. integer :: k, kb, kp1, nm1, nm2 real(wp) :: t