From 111566e75124a7b343de56a1f355c93678dddbc8 Mon Sep 17 00:00:00 2001
From: Edward Hartnett <38856240+edwardhartnett@users.noreply.github.com>
Date: Fri, 19 Feb 2021 12:40:37 -0700
Subject: [PATCH] improved docs in write_data (#306)

* improved docs in write_data

* Update author in chgres_cube.fd/write_data.F90

Fixes #305
Part of #191

Co-authored-by: George Gayno <George.Gayno@noaa.gov>
---
 sorc/chgres_cube.fd/write_data.F90 | 29 ++++++++++++++---------------
 1 file changed, 14 insertions(+), 15 deletions(-)

diff --git a/sorc/chgres_cube.fd/write_data.F90 b/sorc/chgres_cube.fd/write_data.F90
index c4014bbae..ff142ec23 100644
--- a/sorc/chgres_cube.fd/write_data.F90
+++ b/sorc/chgres_cube.fd/write_data.F90
@@ -1,16 +1,16 @@
 !> @file
 !! @brief Write model coldstart files.
 !!
-!! @author gayno NCEP/EMC
+!! @author George Gayno NCEP/EMC
 !!
 !! Write out target grid data into appropriate files for
 !! the forecast model.
 !!
 
-!> @brief Writes atmospheric header file in netcdf format
-!!
-!! @author gayno NCEP/EMC
+!> Writes atmospheric header file in netcdf format.
 !!
+!! @param[in] localpet  ESMF local persistent execution thread
+!! @author George Gayno NCEP/EMC
  subroutine write_fv3_atm_header_netcdf(localpet)
 
  use esmf
@@ -79,12 +79,11 @@ subroutine write_fv3_atm_header_netcdf(localpet)
 
  end subroutine write_fv3_atm_header_netcdf
 
-!> @brief 
-!! Writes atmospheric fields along the lateral boundary.
-!! For regional grids only.  Output in netcdf format.
+!> Writes atmospheric fields along the lateral boundary.
+!! For regional grids only. Output in netcdf format.
 !!   
-!! @author gayno NCEP/EMC
-!!
+!! @param[in] localpet  ESMF local persistent execution thread
+!! @author George Gayno NCEP/EMC
  subroutine write_fv3_atm_bndy_data_netcdf(localpet)
 
 !---------------------------------------------------------------------------
@@ -1183,14 +1182,14 @@ subroutine write_fv3_atm_bndy_data_netcdf(localpet)
 
  end subroutine write_fv3_atm_bndy_data_netcdf
 
-!> @brief Write atmospheric coldstart files (netcdf format).
-!!
-!! @author gayno NCEP/EMC
+!> Write atmospheric coldstart files (netcdf format).
 !!
 !! Routine writes tiled files in parallel.  Tile 1 is written by
 !! localpet 0; tile 2 by localpet 1, etc.  The number of pets
 !! must be equal to or greater than the number of tiled files.
 !!
+!! @param[in] localpet  ESMF local persistent execution thread
+!! @author George Gayno NCEP/EMC
  subroutine write_fv3_atm_data_netcdf(localpet)
 
  use esmf
@@ -1800,10 +1799,10 @@ subroutine write_fv3_atm_data_netcdf(localpet)
 
  end subroutine write_fv3_atm_data_netcdf
 
-!> @brief Writes surface and nst data into a 'coldstart' file (netcdf).
+!> Writes surface and nst data into a 'coldstart' file (netcdf).
 !! 
-!! @author gayno NCEP/EMC
-!!
+!! @param[in] localpet  ESMF local persistent execution thread
+!! @author George Gayno NCEP/EMC
  subroutine write_fv3_sfc_data_netcdf(localpet)
 
  use esmf