From deea5d779b623c30f0a09ef036dbd6e829217467 Mon Sep 17 00:00:00 2001 From: Jacob Williams Date: Fri, 5 Jan 2024 09:06:50 -0600 Subject: [PATCH] updates to ford docs --- .github/workflows/CI.yml | 2 +- README.md | 4 ++-- bspline-fortran.md => ford.md | 5 +---- src/bspline_sub_module.f90 | 6 ++++-- 4 files changed, 8 insertions(+), 9 deletions(-) rename bspline-fortran.md => ford.md (93%) diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml index ac7ba159..fe11fa83 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 ./bspline-fortran.md + run: ford ./ford.md - name: Deploy Documentation if: github.ref == 'refs/heads/master' diff --git a/README.md b/README.md index 1fda254a..09d52f9e 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Multidimensional B-Spline Interpolation of Data on a Regular Grid. ## Status - +[![Language](https://img.shields.io/badge/-Fortran-734f96?logo=fortran&logoColor=white)](https://github.com/topics/fortran) [![GitHub release](https://img.shields.io/github/release/jacobwilliams/bspline-fortran.svg)](https://github.com/jacobwilliams/bspline-fortran/releases/latest) [![Build Status](https://github.com/jacobwilliams/bspline-fortran/actions/workflows/CI.yml/badge.svg)](https://github.com/jacobwilliams/bspline-fortran/actions) [![codecov](https://codecov.io/gh/jacobwilliams/bspline-fortran/branch/master/graph/badge.svg)](https://codecov.io/gh/jacobwilliams/bspline-fortran) @@ -184,7 +184,7 @@ However, note that an external BLAS can only be used if the library is compiled ## Documentation -The latest API documentation can be found [here](https://jacobwilliams.github.io/bspline-fortran/). This was generated from the source code using [FORD](https://github.com/Fortran-FOSS-Programmers/ford) (i.e. by running `ford bspline-fortran.md`). +The latest API documentation can be found [here](https://jacobwilliams.github.io/bspline-fortran/). This was generated from the source code using [FORD](https://github.com/Fortran-FOSS-Programmers/ford) (i.e. by running `ford ford.md`). ## License diff --git a/bspline-fortran.md b/ford.md similarity index 93% rename from bspline-fortran.md rename to ford.md index 04020e14..54cb2c35 100644 --- a/bspline-fortran.md +++ b/ford.md @@ -1,5 +1,5 @@ project: bspline-fortran -project_dir: ./src +src_dir: ./src output_dir: ./doc media_dir: ./media project_github: https://github.com/jacobwilliams/bspline-fortran @@ -15,9 +15,6 @@ display: public private source: true graph: true -exclude: pyplot_module.f90 - test.f90 -exclude_dir: ./src/tests extra_mods: pyplot_module:https://github.com/jacobwilliams/pyplot-fortran ### Brief description diff --git a/src/bspline_sub_module.f90 b/src/bspline_sub_module.f90 index 37ff1620..af30a852 100644 --- a/src/bspline_sub_module.f90 +++ b/src/bspline_sub_module.f90 @@ -2633,8 +2633,10 @@ pure subroutine dbtpcf(x,n,fcn,ldf,nf,t,k,bcoef,work,iflag) real(wp),dimension(:),intent(in) :: t real(wp),dimension(nf,n),intent(out) :: bcoef real(wp),dimension(*),intent(out) :: work !! work array of size >= `2*k*(n+1)` - integer(ip),intent(out) :: iflag !! 0: no errors - !! 301: n should be >0 + integer(ip),intent(out) :: iflag !! status flag: + !! + !! * 0: no errors + !! * 301: n should be >0 integer(ip) :: i, j, m1, m2, iq, iw