Added FORD doc markers to stdlib_io fmt specifiers. Changed iso_fortran_env to stdlib_kinds in spec file.

Author: lewisfish

doc/specs/stdlib_io.md

@@ -289,23 +289,23 @@ Provides formats for all kinds as defined in the `stdlib_kinds` module.
 
 ```fortran
 program demo_fmt_constants
-    use, intrinsic :: iso_fortran_env, only : int32, int64, real32, real64
-    use stdlib_io, only : FMT_INT, FMT_REAL_SP, FMT_REAL_DP, FMT_COMPLEX_SP, FMT_COMPLEX_DP
+    use, stdlib_kinds, only : int32, int64, sp, dp 
+    use stdlib_io,     only : FMT_INT, FMT_REAL_SP, FMT_REAL_DP, FMT_COMPLEX_SP, FMT_COMPLEX_DP
     implicit none
 
-    integer(kind=int32)  :: i32
-    integer(kind=int64)  :: i64
-    real(kind=real32)    :: r32
-    real(kind=real64)    :: r64
-    complex(kind=real32) :: c32
-    complex(kind=real64) :: c64
+    integer(kind=int32) :: i32
+    integer(kind=int64) :: i64
+    real(kind=sp)       :: r32
+    real(kind=dp)       :: r64
+    complex(kind=sp)    :: c32
+    complex(kind=dp)    :: c64
 
     i32 = 100_int32
     i64 = 100_int64
-    r32 = 100.0_real32
-    r64 = 100.0_real64
-    c32 = cmplx(100.0_real32, kind=real32)
-    c64 = cmplx(100.0_real64, kind=real64)
+    r32 = 100.0_sp
+    r64 = 100.0_dp
+    c32 = cmplx(100.0_sp, kind=sp)
+    c64 = cmplx(100.0_dp, kind=dp)
 
     print "(2("//FMT_INT//",1x))", i32, i64 ! outputs: 100 100
     print FMT_REAL_SP, r32                  ! outputs: 1.00000000E+02

src/stdlib_io.fypp

@@ -21,16 +21,28 @@ module stdlib_io
   ! Private API that is exposed so that we can test it in tests
   public :: parse_mode
 
-  ! Format strings with edit descriptors for each type and kind
+  !> Version: experimental
+  !>
+  !> Format strings with edit descriptors for each type and kind
+  !> The specification of this module is available [here](../page/specs/stdlib_io.html).
   character(*), parameter :: &
+    !> Format string for integers
     FMT_INT = '(i0)', &
+    !> Format string for single precision real numbers
     FMT_REAL_SP = '(es15.8e2)', &
+    !> Format string for souble precision real numbers
     FMT_REAL_DP = '(es24.16e3)', &
+    !> Format string for extended double precision real numbers
     FMT_REAL_XDP = '(es26.18e3)', &
+    !> Format string for quadruple precision real numbers
     FMT_REAL_QP = '(es44.35e4)', &
+    !> Format string for single precision complex numbers
     FMT_COMPLEX_SP = '(es15.8e2,1x,es15.8e2)', &
+    !> Format string for double precision complex numbers
     FMT_COMPLEX_DP = '(es24.16e3,1x,es24.16e3)', &
+    !> Format string for extended double precision complex numbers
     FMT_COMPLEX_XDP = '(es26.18e3,1x,es26.18e3)', &
+    !> Format string for quadruple precision complex numbers
     FMT_COMPLEX_QP = '(es44.35e4,1x,es44.35e4)'
 
   public :: FMT_INT, FMT_REAL_SP, FMT_REAL_DP, FMT_REAL_XDP, FMT_REAL_QP