Doxygen updates.

Fixes ufs-community#673.
GeorgeGayno-NOAA · Jul 27, 2022 · 13a3c44 · 13a3c44
1 parent 004ce0f
commit 13a3c44
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 3 deletions.
diff --git a/docs/user_guide.md b/docs/user_guide.md
@@ -75,3 +75,6 @@ https://github.com/ufs-community/UFS_UTILS.
 - <a href="cpld_gridgen/index.html">cpld_gridgen</a> - Utility to 
   create the Fix and IC files for the S2SW and S2S applications 
 
+- <a href="weight_gen/index.html">weight_gen</a> - Utility to 
+  create gaussian grid ESMF 'scrip' files for use in creating
+  ESMF interpolation weight files.
diff --git a/sorc/weight_gen.fd/docs/user_guide.md b/sorc/weight_gen.fd/docs/user_guide.md
@@ -3,7 +3,8 @@
 
 # Introduction
 
-Creates script files.
+Creates ESMF 'scrip' files for gaussian grids. These files
+may then be used to create ESMF interpolation weight files.
 
 This document is part of the <a href="../index.html">UFS_UTILS
 documentation</a>.

diff --git a/sorc/weight_gen.fd/scrip.F90 b/sorc/weight_gen.fd/scrip.F90
@@ -1,5 +1,5 @@
 !> @file
-!! @brief Create "scrip" files for a gaussian grid.
+!! @brief Create ESMF "scrip" files for a gaussian grid.
 !!
 !! @author George Gayno NOAA/EMC
 
@@ -11,7 +11,7 @@
 !! FV3 grid. It then selects a gaussian grid of comparable
 !! resolution. 
 !! 
-!! Two files are created: the normal gaussian grid and one with
+!! Two files are created: the normal gaussian grid, and one with
 !! two extra rows for the N/S poles. Both files are NetCDF.
 !!
 !! @return 0 for success.