Add some docs

Author: minhqdao

src/stdlib_array.fypp

@@ -4,7 +4,7 @@
 #:set RANKS = range(1, MAXRANK + 1)
 #:set KINDS_TYPES = REAL_KINDS_TYPES + INT_KINDS_TYPES + CMPLX_KINDS_TYPES
 
-!> Module for index manipulation and general array handling
+!> Module for general array handling and index manipulation.
 !>
 !> The specification of this module is available [here](../page/specs/stdlib_array.html).
 module stdlib_array

src/stdlib_filesystem.f90

@@ -1,3 +1,6 @@
+! SPDX-Identifier: MIT
+
+!> Interaction with the filesystem.
 module stdlib_filesystem
  use stdlib_string_type, only: string_type
  implicit none
@@ -10,7 +13,11 @@ module stdlib_filesystem
 
 contains
 
+ !> Version: experimental
+ !>
+ !> Whether a file or directory exists at the given path.
  logical function exists(filename)
+ !> Name of the file or directory.
  character(len=*), intent(in) :: filename
 
  inquire(file=filename, exist=exists)
@@ -20,11 +27,17 @@ logical function exists(filename)
 #endif
  end
 
+ !> Version: experimental
+ !>
  !> List files and directories of a directory. Does not list hidden files.
  subroutine list_dir(dir, files, stat, msg)
+ !> Directory to list.
  character(len=*), intent(in) :: dir
+ !> List of files and directories.
  type(string_type), allocatable, intent(out) :: files(:)
+ !> Status of listing.
  integer, intent(out) :: stat
+ !> Error message.
  character(len=:), allocatable, optional, intent(out) :: msg
 
  integer :: unit, iostat
@@ -60,9 +73,15 @@ subroutine list_dir(dir, files, stat, msg)
  close(unit, status="delete")
  end
 
+ !> Version: experimental
+ !>
+ !> Run a command in the shell.
  subroutine run(command, stat, msg)
+ !> Command to run.
  character(len=*), intent(in) :: command
+ !> Status of the operation.
  integer, intent(out), optional :: stat
+ !> Error message.
  character(len=:), allocatable, intent(out), optional :: msg
 
  integer :: exitstat, cmdstat

src/stdlib_io_np.fypp

@@ -4,7 +4,7 @@
 #:set RANKS = range(1, MAXRANK + 1)
 #:set KINDS_TYPES = REAL_KINDS_TYPES + INT_KINDS_TYPES + CMPLX_KINDS_TYPES
 
-!> Description of the npy format taken from
+!> Description of the npy and npz formats taken from
 !> https://numpy.org/doc/stable/reference/generated/numpy.lib.format.html
 !>
 !>## Format Version 1.0

src/stdlib_io_np_load.fypp

@@ -101,10 +101,7 @@ contains
 #:endfor
 #:endfor
 
- !> Version: experimental
- !>
  !> Load multidimensional arrays from a compressed or uncompressed npz file.
- !> ([Specification](../page/specs/stdlib_io.html#load_npz))
  module subroutine load_npz_to_arrays(filename, arrays, iostat, iomsg, tmp_dir)
  character(len=*), intent(in) :: filename
  type(array_wrapper_type), allocatable, intent(out) :: arrays(:)
@@ -145,11 +142,17 @@ contains
  end if
  end
 
+ !> Load arrays from unzipped files.
  subroutine load_unzipped_files_to_arrays(files, dir, arrays, stat, msg)
+ !> List of files to load arrays from.
  type(string_type), intent(in) :: files(:)
+ !> Directory containing the files.
  character(len=*), intent(in) :: dir
+ !> Array of array wrappers to store the loaded arrays.
  type(array_wrapper_type), allocatable, intent(out) :: arrays(:)
+ !> Status of the operation. Zero on success.
  integer, intent(out) :: stat
+ !> Error message in case of non-zero status.
  character(len=:), allocatable, intent(out) :: msg
 
  integer :: i, io

src/stdlib_io_np_save.fypp

@@ -135,10 +135,7 @@ contains
 #:endfor
 #:endfor
 
- !> Version: experimental
- !>
  !> Save multidimensional arrays to a compressed or an uncompressed npz file.
- !> ([Specification](../page/specs/stdlib_io.html#save_npz))
  module subroutine save_arrays_to_npz(filename, arrays, iostat, iomsg, compressed)
  !> Name of the npz file to save to.
  character(len=*), intent(in) :: filename

src/stdlib_io_zip.f90

@@ -1,3 +1,6 @@
+! SPDX-Identifier: MIT
+
+!> Handling of zip files including creation and extraction.
 module stdlib_io_zip
  use stdlib_filesystem, only: exists, run, temp_dir
  use stdlib_string_type, only: string_type, char
@@ -12,11 +15,19 @@ module stdlib_io_zip
 
 contains
 
+ !> Version: experimental
+ !>
+ !> Create a zip file from a list of files.
  subroutine zip(output_file, files, stat, msg, compressed)
+ !> Name of the zip file to create.
  character(*), intent(in) :: output_file
+ !> List of files to include in the zip file.
  type(string_type), intent(in) :: files(:)
+ !> Optional error status of zipping, zero on success.
  integer, intent(out), optional :: stat
+ !> Optional error message.
  character(len=:), allocatable, intent(out), optional :: msg
+ !> If true, the file is saved in compressed format. The default is true.
  logical, intent(in), optional :: compressed
 
  integer :: run_stat, i
@@ -54,10 +65,17 @@ subroutine zip(output_file, files, stat, msg, compressed)
  end if
  end
 
+ !> Version: experimental
+ !>
+ !> Extract a zip file to a directory.
  subroutine unzip(filename, outputdir, stat, msg)
+ !> Name of the zip file to extract.
  character(len=*), intent(in) :: filename
+ !> Directory to extract the zip file to.
  character(len=*), intent(in), optional :: outputdir
+ !> Optional error status of unzipping, zero on success.
  integer, intent(out), optional :: stat
+ !> Optional error message.
  character(len=:), allocatable, intent(out), optional :: msg
 
  integer :: run_stat