more doxygen for sorc/nst_ft_chg.fd

sorc/nst_tf_chg.fd/nc_check.f90

@@ -1,4 +1,10 @@
 !> @file
+!! @brief Contains subroutine to Check netCDF return code.
+
+!> Check netCDF return code, printing error message for errors.
+!!
+!! @param status the error code to check
+!! @author Xu Li @date Mar, 2017
 subroutine nc_check(status)
 
   use netcdf

sorc/nst_tf_chg.fd/nst_tf_chg.f90

@@ -1,5 +1,8 @@
 !> @file
-!! Replace tref to be a new one by
+!! @brief Replace tref to be a new one.
+!! @author Xu Li @date Mar, 2017
+
+!> Replace tref to be a new one by
 !! 1. Read in a new Tref
 !! 2. Smoothing Tref
 !! @author Xu Li @date Mar, 2017

sorc/nst_tf_chg.fd/read_tfs_nc.f90

@@ -1,7 +1,15 @@
 !> @file
+!! @brief Contains function to Read Tf at GFS Gaussin grids in netCDF.
+!! @author Fanglin Yang
 !
-!> Read Tf at GFS Gaussin grids in netCDF 
+!> Read Tf at GFS Gaussin grids in netCDF.
 !!
+!! @param[in] filename the name of the data file we will read.
+!! @param tf
+!! @param mask
+!! @param nlon
+!! @param nlat
+!! @author Fanglin Yang
 subroutine read_tfs_nc(filename,tf,mask,nlon,nlat)
   use netcdf
   implicit none

sorc/nst_tf_chg.fd/read_tfs_nc_2d.f90

@@ -1,6 +1,15 @@
 !> @file
-!! Read Tf at GFS Gaussin grids in netCDF.
+!! @brief Read Tf at GFS Gaussin grids in netCDF.
+!! @author Fanglin Yang
 !
+!> Read Tf at GFS Gaussin grids in netCDF.
+!!
+!! @param filename name of the data file we will read
+!! @param tf
+!! @param mask
+!! @param nlon
+!! @param nlat
+!! @author Fanglin Yang
 subroutine read_tfs_nc_2d(filename,tf,mask,nlon,nlat)
   use netcdf
   implicit none

sorc/nst_tf_chg.fd/setup.f90

@@ -1,25 +1,20 @@
 !> @file
-!! @author  Xu Li @date 2017-03-13
 !!
 !! This module contains variables to run nst_tf_chg.
 !!
-!! Subroutines Included:
-!! -  sub init_grdmod   - initialize grided related variables to default values
-!!
-!! Variable Definitions:
-!! -  def nsmth       - the number of 9-point smooth
-!! -  def missing_value - missing_value
-!!
+!! @author Xu Li @date 2017-03-13
 module setup
 
-  integer :: nsmth,istyp
+  integer :: nsmth !< the number of 9-point smooth
+  integer :: istyp
 
 contains
 
+  !> Initialize grided related variables to default values. Set
+  !! defaults for observation related variables.
+  !!
+  !! @author Xu Li @date 2017-03-13
   subroutine init_setup
-!
-! abstract:  set defaults for observation related variables
-!
     implicit none
 
 !   Initialize arrays used in namelist obs_input 

sorc/nst_tf_chg.fd/smth9_msk.f90

@@ -1,21 +1,22 @@
 !> @file
-!!                .      .    .
+!! @brief Contains 9-point smoother subroutine.
+
+!> 9-point smoother subroutine.
+!!
 !! smth9_msk --- 9-point smoother with surface mask
 !! by spatial average from a to b with ancillary surface mask (e.g.,
 !! analysis grid => surface grid) for global arrays
 !! to gurantee the averaged value (b) is determined by the
 !! candidates (a) with the identical surface type from (a)
 !!
-!! @author li @date 03/13/2017
-!!
-!! @param[in] a        - real: 2-d array such as analysis increment at analysis grids
-!! @param[out] b       - real: 2-d array 
-!! @param[in] isli   - integer: 2-d array: surface mask (0 = water, 1 = land, 2 = sea ice) for a grids
-!! @param[in] nlon     - integer: number of longitude of a & b
-!! @param[in] nlat     - integer: number of latitude of a & b
-!! @param[in] istyp    - integer: target surface type value
-!!
+!! @param[in] a real: 2-d array such as analysis increment at analysis grids
+!! @param[out] b real: 2-d array 
+!! @param[in] isli integer: 2-d array: surface mask (0 = water, 1 = land, 2 = sea ice) for a grids
+!! @param[in] nlon integer: number of longitude of a & b
+!! @param[in] nlat integer: number of latitude of a & b
+!! @param[in] istyp integer: target surface type value
 !!
+!! @author  Xu Li @date 2017-03-13
  subroutine smth9_msk(a,b,isli,nlon,nlat,istyp)
 ! USES: