doxygen improvements for sorc/grid_tools.fd/regional_esg_grid.fd/pesg…

….f90 (#371) * Part of Doxygen updates for sorc/grid_tools.fd #366 doxygen update for pesg.f90 * Part of Doxygen updates for sorc/grid_tools.fd #366 doxygen update for sorc/grid_tools.fd/regional_esg_grid.fd/pesg.f90 * doxygen fixes * more doxygen work * more doxygen Co-authored-by: Edward Hartnett <Edward.Hartnett@noaa.gov> Co-authored-by: Edward Hartnett <38856240+edwardhartnett@users.noreply.github.com>
ufs-community · Mar 4, 2021 · cf23dca · cf23dca
1 parent 6d08f8c
commit cf23dca
Show file tree

Hide file tree

Showing 5 changed files with 783 additions and 479 deletions.
diff --git a/docs/Doxyfile.in b/docs/Doxyfile.in
@@ -913,13 +913,13 @@ STRIP_CODE_COMMENTS    = YES
 # function all documented functions referencing it will be listed.
 # The default value is: NO.
 
-REFERENCED_BY_RELATION = NO
+REFERENCED_BY_RELATION = YES
 
 # If the REFERENCES_RELATION tag is set to YES then for each documented function
 # all documented entities called/used by that function will be listed.
 # The default value is: NO.
 
-REFERENCES_RELATION    = NO
+REFERENCES_RELATION    = YES
 
 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
 # to YES, then the hyperlinks from functions in REFERENCES_RELATION and

diff --git a/sorc/grid_tools.fd/CMakeLists.txt b/sorc/grid_tools.fd/CMakeLists.txt
@@ -1,3 +1,6 @@
+# This is the CMake file for the grid_tools utilites of UFS_UTILS.
+#
+# George Gayno
 add_subdirectory(shave.fd)
 add_subdirectory(filter_topo.fd)
 add_subdirectory(regional_esg_grid.fd)

diff --git a/sorc/grid_tools.fd/regional_esg_grid.fd/CMakeLists.txt b/sorc/grid_tools.fd/regional_esg_grid.fd/CMakeLists.txt
@@ -1,3 +1,7 @@
+# This is the CMake file for the regional_esf_grid utility in
+# UFS_UTILS.
+#
+# George Gayno
 set(fortran_src
     pesg.f90
     pfun.f90