doxygen fixes for sorc/chgres_cube.fd/chgres.F90 (#319)

* doxygen fixes * Minor doxygen updates to chgres.F90. Fixes #318 Co-authored-by: George Gayno <[email protected]>
ufs-community · Feb 22, 2021 · 23e4e3a · 23e4e3a
1 parent 317636c
commit 23e4e3a
Showing 1 changed file with 11 additions and 4 deletions.
diff --git a/sorc/chgres_cube.fd/chgres.F90 b/sorc/chgres_cube.fd/chgres.F90
@@ -1,12 +1,19 @@
 !> @file
 !! @brief Initialize an FV3 model run.
 !!
-!! Program CHGRES_CUBE
+!! Initialize an FV3 run using history or restart data from another
+!! FV3 run, the spectral GFS, and a few other models. Converts
+!! atmospheric, surface and nst data.
 !!
-!! Initialize an FV3 run using history or restart data from
-!! another FV3 run, the spectral GFS, and a few other models.
-!! Converts atmospheric, surface and nst data.
+!! This file reads a configuration namelist.
 !!
+!! Usage:
+!! Link the configuration namelist to ./fort.41.  Then run the
+!! program with a multiple of six mpi tasks (an ESMF library
+!! requirement for fv3 cubed sphere grids).
+!!
+!!
+!! @author George Gayno NOAA/EMC
  program chgres
 
  use mpi