From 773fe3c6eee6a0d20db2d02036b7cac26d0779b3 Mon Sep 17 00:00:00 2001 From: GeorgeGayno-NOAA <52789452+GeorgeGayno-NOAA@users.noreply.github.com> Date: Tue, 17 Oct 2023 16:29:33 -0400 Subject: [PATCH] Doxygen Updates (#853) Fixes #835. --- docs/Doxyfile.in | 4 ++-- docs/README.md | 5 +++++ docs/{user_guide.md => main.md} | 0 sorc/chgres_cube.fd/docs/Doxyfile.in | 4 ++-- sorc/chgres_cube.fd/docs/README.md | 4 ++++ sorc/chgres_cube.fd/docs/{user_guide.md => chgres_cube.md} | 0 sorc/cpld_gridgen.fd/docs/Doxyfile.in | 4 ++-- sorc/cpld_gridgen.fd/docs/README.md | 4 ++++ sorc/cpld_gridgen.fd/docs/{user_guide.md => cpld_gridgen.md} | 0 sorc/emcsfc_ice_blend.fd/docs/Doxyfile.in | 4 ++-- sorc/emcsfc_ice_blend.fd/docs/README.md | 4 ++++ .../docs/{user_guide.md => emc_ice_blend.md} | 0 sorc/emcsfc_snow2mdl.fd/docs/Doxyfile.in | 4 ++-- sorc/emcsfc_snow2mdl.fd/docs/README.md | 4 ++++ .../docs/{user_guide.md => emcsfc_snow2mdl.md} | 0 sorc/fvcom_tools.fd/docs/Doxyfile.in | 4 ++-- sorc/fvcom_tools.fd/docs/README.md | 5 +++++ sorc/fvcom_tools.fd/docs/{user_guide.md => fvcom_tools.md} | 0 sorc/gblevents.fd/docs/Doxyfile.in | 4 ++-- sorc/gblevents.fd/docs/README.md | 3 +++ sorc/gblevents.fd/docs/{user_guide.md => gblevents.md} | 0 sorc/gblevents.fd/gblevents.f | 1 + sorc/global_cycle.fd/docs/Doxyfile.in | 4 ++-- sorc/global_cycle.fd/docs/README.md | 5 +++++ sorc/global_cycle.fd/docs/{user_guide.md => global_cycle.md} | 0 sorc/grid_tools.fd/docs/Doxyfile.in | 4 ++-- sorc/grid_tools.fd/docs/README.md | 3 +++ sorc/grid_tools.fd/docs/{user_guide.md => grid_tools.md} | 0 sorc/lsm_routines.fd/docs/Doxyfile.in | 4 ++-- sorc/lsm_routines.fd/docs/README.md | 4 ++++ sorc/lsm_routines.fd/docs/{user_guide.md => lsm_routines.md} | 0 sorc/lsm_routines.fd/noah.fd/docs/Doxyfile.in | 4 ++-- sorc/lsm_routines.fd/noah.fd/{readme => docs/README.md} | 2 +- sorc/lsm_routines.fd/noah.fd/docs/{user_guide.md => noah.md} | 0 sorc/orog_mask_tools.fd/docs/Doxyfile.in | 4 ++-- sorc/orog_mask_tools.fd/docs/README.md | 4 ++++ .../docs/{user_guide.md => orog_mask_tools.md} | 0 sorc/sfc_climo_gen.fd/docs/Doxyfile.in | 4 ++-- sorc/sfc_climo_gen.fd/docs/README.md | 4 ++++ .../docs/{user_guide.md => sfc_climo_gen.md} | 0 sorc/vcoord_gen.fd/docs/Doxyfile.in | 4 ++-- sorc/vcoord_gen.fd/docs/README.md | 4 ++++ sorc/vcoord_gen.fd/docs/{user_guide.md => vcoord_gen.md} | 0 43 files changed, 83 insertions(+), 29 deletions(-) create mode 100644 docs/README.md rename docs/{user_guide.md => main.md} (100%) create mode 100644 sorc/chgres_cube.fd/docs/README.md rename sorc/chgres_cube.fd/docs/{user_guide.md => chgres_cube.md} (100%) create mode 100644 sorc/cpld_gridgen.fd/docs/README.md rename sorc/cpld_gridgen.fd/docs/{user_guide.md => cpld_gridgen.md} (100%) create mode 100644 sorc/emcsfc_ice_blend.fd/docs/README.md rename sorc/emcsfc_ice_blend.fd/docs/{user_guide.md => emc_ice_blend.md} (100%) create mode 100644 sorc/emcsfc_snow2mdl.fd/docs/README.md rename sorc/emcsfc_snow2mdl.fd/docs/{user_guide.md => emcsfc_snow2mdl.md} (100%) create mode 100644 sorc/fvcom_tools.fd/docs/README.md rename sorc/fvcom_tools.fd/docs/{user_guide.md => fvcom_tools.md} (100%) create mode 100644 sorc/gblevents.fd/docs/README.md rename sorc/gblevents.fd/docs/{user_guide.md => gblevents.md} (100%) create mode 100644 sorc/global_cycle.fd/docs/README.md rename sorc/global_cycle.fd/docs/{user_guide.md => global_cycle.md} (100%) create mode 100644 sorc/grid_tools.fd/docs/README.md rename sorc/grid_tools.fd/docs/{user_guide.md => grid_tools.md} (100%) create mode 100644 sorc/lsm_routines.fd/docs/README.md rename sorc/lsm_routines.fd/docs/{user_guide.md => lsm_routines.md} (100%) rename sorc/lsm_routines.fd/noah.fd/{readme => docs/README.md} (91%) rename sorc/lsm_routines.fd/noah.fd/docs/{user_guide.md => noah.md} (100%) create mode 100644 sorc/orog_mask_tools.fd/docs/README.md rename sorc/orog_mask_tools.fd/docs/{user_guide.md => orog_mask_tools.md} (100%) create mode 100644 sorc/sfc_climo_gen.fd/docs/README.md rename sorc/sfc_climo_gen.fd/docs/{user_guide.md => sfc_climo_gen.md} (100%) create mode 100644 sorc/vcoord_gen.fd/docs/README.md rename sorc/vcoord_gen.fd/docs/{user_guide.md => vcoord_gen.md} (100%) diff --git a/docs/Doxyfile.in b/docs/Doxyfile.in index c0874346c..6c78b87cb 100644 --- a/docs/Doxyfile.in +++ b/docs/Doxyfile.in @@ -854,7 +854,7 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = @abs_top_srcdir@/docs/user_guide.md +INPUT = @abs_top_srcdir@/docs/main.md # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses @@ -1014,7 +1014,7 @@ FILTER_SOURCE_PATTERNS = # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. -USE_MDFILE_AS_MAINPAGE = @abs_top_srcdir@/docs/sp_user_guide.md +USE_MDFILE_AS_MAINPAGE = @abs_top_srcdir@/docs/main.md #--------------------------------------------------------------------------- # Configuration options related to source browsing diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 000000000..99e6c4cb7 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,5 @@ +For documentation see: + +https://ufs-community.github.io/UFS_UTILS + +https://noaa-emcufs-utils.readthedocs.io/en/latest diff --git a/docs/user_guide.md b/docs/main.md similarity index 100% rename from docs/user_guide.md rename to docs/main.md diff --git a/sorc/chgres_cube.fd/docs/Doxyfile.in b/sorc/chgres_cube.fd/docs/Doxyfile.in index f66dd3943..9e6dcf0e3 100644 --- a/sorc/chgres_cube.fd/docs/Doxyfile.in +++ b/sorc/chgres_cube.fd/docs/Doxyfile.in @@ -854,7 +854,7 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = @abs_top_srcdir@/sorc/chgres_cube.fd/docs/user_guide.md \ +INPUT = @abs_top_srcdir@/sorc/chgres_cube.fd/docs/chgres_cube.md \ @abs_top_srcdir@/sorc/chgres_cube.fd # This tag can be used to specify the character encoding of the source files @@ -1015,7 +1015,7 @@ FILTER_SOURCE_PATTERNS = # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. -USE_MDFILE_AS_MAINPAGE = user_guide.md +USE_MDFILE_AS_MAINPAGE = chgres_cube.md #--------------------------------------------------------------------------- # Configuration options related to source browsing diff --git a/sorc/chgres_cube.fd/docs/README.md b/sorc/chgres_cube.fd/docs/README.md new file mode 100644 index 000000000..f035d6b47 --- /dev/null +++ b/sorc/chgres_cube.fd/docs/README.md @@ -0,0 +1,4 @@ +The chgres_cube program creates initial condition files to coldstart +the forecast model. + +Documentation may be found at https://ufs-community.github.io/UFS_UTILS diff --git a/sorc/chgres_cube.fd/docs/user_guide.md b/sorc/chgres_cube.fd/docs/chgres_cube.md similarity index 100% rename from sorc/chgres_cube.fd/docs/user_guide.md rename to sorc/chgres_cube.fd/docs/chgres_cube.md diff --git a/sorc/cpld_gridgen.fd/docs/Doxyfile.in b/sorc/cpld_gridgen.fd/docs/Doxyfile.in index 62808f419..8c64d2d93 100644 --- a/sorc/cpld_gridgen.fd/docs/Doxyfile.in +++ b/sorc/cpld_gridgen.fd/docs/Doxyfile.in @@ -855,7 +855,7 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = @abs_top_srcdir@/sorc/cpld_gridgen.fd/docs/user_guide.md \ +INPUT = @abs_top_srcdir@/sorc/cpld_gridgen.fd/docs/cpld_gridgen.md \ @abs_top_srcdir@/sorc/cpld_gridgen.fd # This tag can be used to specify the character encoding of the source files @@ -1016,7 +1016,7 @@ FILTER_SOURCE_PATTERNS = # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. -USE_MDFILE_AS_MAINPAGE = user_guide.md +USE_MDFILE_AS_MAINPAGE = cpld_gridgen.md #--------------------------------------------------------------------------- # Configuration options related to source browsing diff --git a/sorc/cpld_gridgen.fd/docs/README.md b/sorc/cpld_gridgen.fd/docs/README.md new file mode 100644 index 000000000..ed90be316 --- /dev/null +++ b/sorc/cpld_gridgen.fd/docs/README.md @@ -0,0 +1,4 @@ +This program creates the files required for the Fix and IC files for +the coupled model. + +Documentation may be found at https://ufs-community.github.io/UFS_UTILS diff --git a/sorc/cpld_gridgen.fd/docs/user_guide.md b/sorc/cpld_gridgen.fd/docs/cpld_gridgen.md similarity index 100% rename from sorc/cpld_gridgen.fd/docs/user_guide.md rename to sorc/cpld_gridgen.fd/docs/cpld_gridgen.md diff --git a/sorc/emcsfc_ice_blend.fd/docs/Doxyfile.in b/sorc/emcsfc_ice_blend.fd/docs/Doxyfile.in index ce7bc1001..156246c25 100644 --- a/sorc/emcsfc_ice_blend.fd/docs/Doxyfile.in +++ b/sorc/emcsfc_ice_blend.fd/docs/Doxyfile.in @@ -854,7 +854,7 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = @abs_top_srcdir@/sorc/emcsfc_ice_blend.fd/docs/user_guide.md \ +INPUT = @abs_top_srcdir@/sorc/emcsfc_ice_blend.fd/docs/emc_ice_blend.md \ @abs_top_srcdir@/sorc/emcsfc_ice_blend.fd # This tag can be used to specify the character encoding of the source files @@ -1015,7 +1015,7 @@ FILTER_SOURCE_PATTERNS = # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. -USE_MDFILE_AS_MAINPAGE = user_guide.md +USE_MDFILE_AS_MAINPAGE = emc_ice_blend.md #--------------------------------------------------------------------------- # Configuration options related to source browsing diff --git a/sorc/emcsfc_ice_blend.fd/docs/README.md b/sorc/emcsfc_ice_blend.fd/docs/README.md new file mode 100644 index 000000000..b6ea661ed --- /dev/null +++ b/sorc/emcsfc_ice_blend.fd/docs/README.md @@ -0,0 +1,4 @@ +This program blends National Ice Center sea ice cover and EMC +sea ice concentration data to create a global sea ice analysis. + +Documentation may be found at https://ufs-community.github.io/UFS_UTILS diff --git a/sorc/emcsfc_ice_blend.fd/docs/user_guide.md b/sorc/emcsfc_ice_blend.fd/docs/emc_ice_blend.md similarity index 100% rename from sorc/emcsfc_ice_blend.fd/docs/user_guide.md rename to sorc/emcsfc_ice_blend.fd/docs/emc_ice_blend.md diff --git a/sorc/emcsfc_snow2mdl.fd/docs/Doxyfile.in b/sorc/emcsfc_snow2mdl.fd/docs/Doxyfile.in index 214bf03d1..1ab605434 100644 --- a/sorc/emcsfc_snow2mdl.fd/docs/Doxyfile.in +++ b/sorc/emcsfc_snow2mdl.fd/docs/Doxyfile.in @@ -854,7 +854,7 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = @abs_top_srcdir@/sorc/emcsfc_snow2mdl.fd/docs/user_guide.md \ +INPUT = @abs_top_srcdir@/sorc/emcsfc_snow2mdl.fd/docs/emcsfc_snow2mdl.md \ @abs_top_srcdir@/sorc/emcsfc_snow2mdl.fd # This tag can be used to specify the character encoding of the source files @@ -1015,7 +1015,7 @@ FILTER_SOURCE_PATTERNS = # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. -USE_MDFILE_AS_MAINPAGE = user_guide.md +USE_MDFILE_AS_MAINPAGE = emcsfc_snow2mdl.md #--------------------------------------------------------------------------- # Configuration options related to source browsing diff --git a/sorc/emcsfc_snow2mdl.fd/docs/README.md b/sorc/emcsfc_snow2mdl.fd/docs/README.md new file mode 100644 index 000000000..d48964525 --- /dev/null +++ b/sorc/emcsfc_snow2mdl.fd/docs/README.md @@ -0,0 +1,4 @@ +This program blends National Ice Center snow cover and Air Force +snow depth data to create a global depth analysis. + +Documentation may be found at https://ufs-community.github.io/UFS_UTILS diff --git a/sorc/emcsfc_snow2mdl.fd/docs/user_guide.md b/sorc/emcsfc_snow2mdl.fd/docs/emcsfc_snow2mdl.md similarity index 100% rename from sorc/emcsfc_snow2mdl.fd/docs/user_guide.md rename to sorc/emcsfc_snow2mdl.fd/docs/emcsfc_snow2mdl.md diff --git a/sorc/fvcom_tools.fd/docs/Doxyfile.in b/sorc/fvcom_tools.fd/docs/Doxyfile.in index d30d6cc27..9d0202f88 100644 --- a/sorc/fvcom_tools.fd/docs/Doxyfile.in +++ b/sorc/fvcom_tools.fd/docs/Doxyfile.in @@ -854,7 +854,7 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = @abs_top_srcdir@/sorc/fvcom_tools.fd/docs/user_guide.md \ +INPUT = @abs_top_srcdir@/sorc/fvcom_tools.fd/docs/fvcom_tools.md \ @abs_top_srcdir@/sorc/fvcom_tools.fd # This tag can be used to specify the character encoding of the source files @@ -1015,7 +1015,7 @@ FILTER_SOURCE_PATTERNS = # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. -USE_MDFILE_AS_MAINPAGE = user_guide.md +USE_MDFILE_AS_MAINPAGE = fvcom_tools.md #--------------------------------------------------------------------------- # Configuration options related to source browsing diff --git a/sorc/fvcom_tools.fd/docs/README.md b/sorc/fvcom_tools.fd/docs/README.md new file mode 100644 index 000000000..a77671271 --- /dev/null +++ b/sorc/fvcom_tools.fd/docs/README.md @@ -0,0 +1,5 @@ +This program replaces lake surface and lake ice temperature along +with aerial ice concentration generated from the Great Lakes +Operational Forecast System (GLOFS) into the model surface restart file. + +Documentation may be found at https://ufs-community.github.io/UFS_UTILS diff --git a/sorc/fvcom_tools.fd/docs/user_guide.md b/sorc/fvcom_tools.fd/docs/fvcom_tools.md similarity index 100% rename from sorc/fvcom_tools.fd/docs/user_guide.md rename to sorc/fvcom_tools.fd/docs/fvcom_tools.md diff --git a/sorc/gblevents.fd/docs/Doxyfile.in b/sorc/gblevents.fd/docs/Doxyfile.in index bcbcac4db..5abb21f95 100644 --- a/sorc/gblevents.fd/docs/Doxyfile.in +++ b/sorc/gblevents.fd/docs/Doxyfile.in @@ -854,7 +854,7 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = @abs_top_srcdir@/sorc/gblevents.fd/docs/user_guide.md \ +INPUT = @abs_top_srcdir@/sorc/gblevents.fd/docs/gblevents.md \ @abs_top_srcdir@/sorc/gblevents.fd # This tag can be used to specify the character encoding of the source files @@ -1015,7 +1015,7 @@ FILTER_SOURCE_PATTERNS = # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. -USE_MDFILE_AS_MAINPAGE = user_guide.md +USE_MDFILE_AS_MAINPAGE = gblevents.md #--------------------------------------------------------------------------- # Configuration options related to source browsing diff --git a/sorc/gblevents.fd/docs/README.md b/sorc/gblevents.fd/docs/README.md new file mode 100644 index 000000000..25bf69112 --- /dev/null +++ b/sorc/gblevents.fd/docs/README.md @@ -0,0 +1,3 @@ +The gblevents program performs pre and post processing of prepbufr events. + +Documentation may be found at https://ufs-community.github.io/UFS_UTILS diff --git a/sorc/gblevents.fd/docs/user_guide.md b/sorc/gblevents.fd/docs/gblevents.md similarity index 100% rename from sorc/gblevents.fd/docs/user_guide.md rename to sorc/gblevents.fd/docs/gblevents.md diff --git a/sorc/gblevents.fd/gblevents.f b/sorc/gblevents.fd/gblevents.f index acc5ce6f9..70d0b9aa8 100644 --- a/sorc/gblevents.fd/gblevents.f +++ b/sorc/gblevents.fd/gblevents.f @@ -2047,6 +2047,7 @@ SUBROUTINE GBLEVN06(XOB,YOB) ! FORMERLY SUBROUTINE HTERP C> - (USED ONLY IN PREVENTS MODE) C> @param OEMIN - REAL MINIMUM VALUE FOR OBS ERROR (FOR VARIABLE BEING C> - INTERPOLATED) +C> @return OEFG01 OBSERVATION ERROR C> C> REMARKS: 'OEFG01' RETURNED IS OBSERVATION ERROR FOR VARIABLE "IE" IN C> REPORT TYPE "TYP", INTERPOLATED TO PRESSURE LEVEL "P". diff --git a/sorc/global_cycle.fd/docs/Doxyfile.in b/sorc/global_cycle.fd/docs/Doxyfile.in index 5d1fffb6a..b565301fa 100644 --- a/sorc/global_cycle.fd/docs/Doxyfile.in +++ b/sorc/global_cycle.fd/docs/Doxyfile.in @@ -854,7 +854,7 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = @abs_top_srcdir@/sorc/global_cycle.fd/docs/user_guide.md \ +INPUT = @abs_top_srcdir@/sorc/global_cycle.fd/docs/global_cycle.md \ @abs_top_srcdir@/sorc/global_cycle.fd # This tag can be used to specify the character encoding of the source files @@ -1015,7 +1015,7 @@ FILTER_SOURCE_PATTERNS = # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. -USE_MDFILE_AS_MAINPAGE = user_guide.md +USE_MDFILE_AS_MAINPAGE = global_cycle.md #--------------------------------------------------------------------------- # Configuration options related to source browsing diff --git a/sorc/global_cycle.fd/docs/README.md b/sorc/global_cycle.fd/docs/README.md new file mode 100644 index 000000000..45365bbe6 --- /dev/null +++ b/sorc/global_cycle.fd/docs/README.md @@ -0,0 +1,5 @@ +This program updates the GFS surface conditions using +external snow and sea ice analyses. It updates monthly climatological +fields such as plant greenness fraction and albedo. + +Documentation may be found at https://ufs-community.github.io/UFS_UTILS diff --git a/sorc/global_cycle.fd/docs/user_guide.md b/sorc/global_cycle.fd/docs/global_cycle.md similarity index 100% rename from sorc/global_cycle.fd/docs/user_guide.md rename to sorc/global_cycle.fd/docs/global_cycle.md diff --git a/sorc/grid_tools.fd/docs/Doxyfile.in b/sorc/grid_tools.fd/docs/Doxyfile.in index bd6a3accd..7b0119611 100644 --- a/sorc/grid_tools.fd/docs/Doxyfile.in +++ b/sorc/grid_tools.fd/docs/Doxyfile.in @@ -854,7 +854,7 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = @abs_top_srcdir@/sorc/grid_tools.fd/docs/user_guide.md \ +INPUT = @abs_top_srcdir@/sorc/grid_tools.fd/docs/grid_tools.md \ @abs_top_srcdir@/sorc/grid_tools.fd # This tag can be used to specify the character encoding of the source files @@ -1015,7 +1015,7 @@ FILTER_SOURCE_PATTERNS = # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. -USE_MDFILE_AS_MAINPAGE = user_guide.md +USE_MDFILE_AS_MAINPAGE = grid_tools.md #--------------------------------------------------------------------------- # Configuration options related to source browsing diff --git a/sorc/grid_tools.fd/docs/README.md b/sorc/grid_tools.fd/docs/README.md new file mode 100644 index 000000000..37aef8e8b --- /dev/null +++ b/sorc/grid_tools.fd/docs/README.md @@ -0,0 +1,3 @@ +Utility programs for creating model grids. + +Documentation may be found at https://ufs-community.github.io/UFS_UTILS diff --git a/sorc/grid_tools.fd/docs/user_guide.md b/sorc/grid_tools.fd/docs/grid_tools.md similarity index 100% rename from sorc/grid_tools.fd/docs/user_guide.md rename to sorc/grid_tools.fd/docs/grid_tools.md diff --git a/sorc/lsm_routines.fd/docs/Doxyfile.in b/sorc/lsm_routines.fd/docs/Doxyfile.in index 8467348f1..d8c40f87d 100644 --- a/sorc/lsm_routines.fd/docs/Doxyfile.in +++ b/sorc/lsm_routines.fd/docs/Doxyfile.in @@ -854,7 +854,7 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = @abs_top_srcdir@/sorc/lsm_routines.fd/docs/user_guide.md +INPUT = @abs_top_srcdir@/sorc/lsm_routines.fd/docs/lsm_routines.md # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses @@ -1014,7 +1014,7 @@ FILTER_SOURCE_PATTERNS = # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. -USE_MDFILE_AS_MAINPAGE = user_guide.md +USE_MDFILE_AS_MAINPAGE = lsm_routines.md #--------------------------------------------------------------------------- # Configuration options related to source browsing diff --git a/sorc/lsm_routines.fd/docs/README.md b/sorc/lsm_routines.fd/docs/README.md new file mode 100644 index 000000000..1ba6836a3 --- /dev/null +++ b/sorc/lsm_routines.fd/docs/README.md @@ -0,0 +1,4 @@ +This directory contains land surface model-specific routines that are +utilised elsewhere within UFS_UTILS. + +Documentation may be found at https://ufs-community.github.io/UFS_UTILS diff --git a/sorc/lsm_routines.fd/docs/user_guide.md b/sorc/lsm_routines.fd/docs/lsm_routines.md similarity index 100% rename from sorc/lsm_routines.fd/docs/user_guide.md rename to sorc/lsm_routines.fd/docs/lsm_routines.md diff --git a/sorc/lsm_routines.fd/noah.fd/docs/Doxyfile.in b/sorc/lsm_routines.fd/noah.fd/docs/Doxyfile.in index 49bd3f7e8..632a044b9 100644 --- a/sorc/lsm_routines.fd/noah.fd/docs/Doxyfile.in +++ b/sorc/lsm_routines.fd/noah.fd/docs/Doxyfile.in @@ -857,7 +857,7 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = @abs_top_srcdir@/sorc/lsm_routines.fd/noah.fd/docs/user_guide.md \ +INPUT = @abs_top_srcdir@/sorc/lsm_routines.fd/noah.fd/docs/noah.md \ @abs_top_srcdir@/sorc/lsm_routines.fd/noah.fd/ # This tag can be used to specify the character encoding of the source files @@ -1018,7 +1018,7 @@ FILTER_SOURCE_PATTERNS = # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. -USE_MDFILE_AS_MAINPAGE = user_guide.md +USE_MDFILE_AS_MAINPAGE = noah.md #--------------------------------------------------------------------------- # Configuration options related to source browsing diff --git a/sorc/lsm_routines.fd/noah.fd/readme b/sorc/lsm_routines.fd/noah.fd/docs/README.md similarity index 91% rename from sorc/lsm_routines.fd/noah.fd/readme rename to sorc/lsm_routines.fd/noah.fd/docs/README.md index 85a292f98..d4968c55e 100644 --- a/sorc/lsm_routines.fd/noah.fd/readme +++ b/sorc/lsm_routines.fd/noah.fd/docs/README.md @@ -10,4 +10,4 @@ set_soilveg.f -> needed some changes for doxygen sflx_snippet.f is a snippet of the file sflx.F, with minor changes to compil, and to enable frh2o routine to be called externally. - +For complete documentation, see https://ufs-community.github.io/UFS_UTILS diff --git a/sorc/lsm_routines.fd/noah.fd/docs/user_guide.md b/sorc/lsm_routines.fd/noah.fd/docs/noah.md similarity index 100% rename from sorc/lsm_routines.fd/noah.fd/docs/user_guide.md rename to sorc/lsm_routines.fd/noah.fd/docs/noah.md diff --git a/sorc/orog_mask_tools.fd/docs/Doxyfile.in b/sorc/orog_mask_tools.fd/docs/Doxyfile.in index c4d9dec55..26bc1b541 100644 --- a/sorc/orog_mask_tools.fd/docs/Doxyfile.in +++ b/sorc/orog_mask_tools.fd/docs/Doxyfile.in @@ -854,7 +854,7 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = @abs_top_srcdir@/sorc/orog_mask_tools.fd/docs/user_guide.md \ +INPUT = @abs_top_srcdir@/sorc/orog_mask_tools.fd/docs/orog_mask_tools.md \ @abs_top_srcdir@/sorc/orog_mask_tools.fd # This tag can be used to specify the character encoding of the source files @@ -1015,7 +1015,7 @@ FILTER_SOURCE_PATTERNS = # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. -USE_MDFILE_AS_MAINPAGE = user_guide.md +USE_MDFILE_AS_MAINPAGE = orog_mask_tools.md #--------------------------------------------------------------------------- # Configuration options related to source browsing diff --git a/sorc/orog_mask_tools.fd/docs/README.md b/sorc/orog_mask_tools.fd/docs/README.md new file mode 100644 index 000000000..c9c117819 --- /dev/null +++ b/sorc/orog_mask_tools.fd/docs/README.md @@ -0,0 +1,4 @@ +These programs are used in creating the terrain and land mask for +a model grid. + +Documentation may be found at https://ufs-community.github.io/UFS_UTILS diff --git a/sorc/orog_mask_tools.fd/docs/user_guide.md b/sorc/orog_mask_tools.fd/docs/orog_mask_tools.md similarity index 100% rename from sorc/orog_mask_tools.fd/docs/user_guide.md rename to sorc/orog_mask_tools.fd/docs/orog_mask_tools.md diff --git a/sorc/sfc_climo_gen.fd/docs/Doxyfile.in b/sorc/sfc_climo_gen.fd/docs/Doxyfile.in index 36fb2baa8..7f35e9ec1 100644 --- a/sorc/sfc_climo_gen.fd/docs/Doxyfile.in +++ b/sorc/sfc_climo_gen.fd/docs/Doxyfile.in @@ -854,7 +854,7 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = @abs_top_srcdir@/sorc/sfc_climo_gen.fd/docs/user_guide.md \ +INPUT = @abs_top_srcdir@/sorc/sfc_climo_gen.fd/docs/sfc_climo_gen.md \ @abs_top_srcdir@/sorc/sfc_climo_gen.fd # This tag can be used to specify the character encoding of the source files @@ -1015,7 +1015,7 @@ FILTER_SOURCE_PATTERNS = # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. -USE_MDFILE_AS_MAINPAGE = user_guide.md +USE_MDFILE_AS_MAINPAGE = sfc_climo_gen.md #--------------------------------------------------------------------------- # Configuration options related to source browsing diff --git a/sorc/sfc_climo_gen.fd/docs/README.md b/sorc/sfc_climo_gen.fd/docs/README.md new file mode 100644 index 000000000..93388c9e8 --- /dev/null +++ b/sorc/sfc_climo_gen.fd/docs/README.md @@ -0,0 +1,4 @@ +This program creates climatological surface fields on the model grid, +such as soil type and albedo. + +Documentation may be found at https://ufs-community.github.io/UFS_UTILS diff --git a/sorc/sfc_climo_gen.fd/docs/user_guide.md b/sorc/sfc_climo_gen.fd/docs/sfc_climo_gen.md similarity index 100% rename from sorc/sfc_climo_gen.fd/docs/user_guide.md rename to sorc/sfc_climo_gen.fd/docs/sfc_climo_gen.md diff --git a/sorc/vcoord_gen.fd/docs/Doxyfile.in b/sorc/vcoord_gen.fd/docs/Doxyfile.in index e998ef6b0..b450c4504 100644 --- a/sorc/vcoord_gen.fd/docs/Doxyfile.in +++ b/sorc/vcoord_gen.fd/docs/Doxyfile.in @@ -854,7 +854,7 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = @abs_top_srcdir@/sorc/vcoord_gen.fd/docs/user_guide.md \ +INPUT = @abs_top_srcdir@/sorc/vcoord_gen.fd/docs/vcoord_gen.md \ @abs_top_srcdir@/sorc/vcoord_gen.fd # This tag can be used to specify the character encoding of the source files @@ -1015,7 +1015,7 @@ FILTER_SOURCE_PATTERNS = # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. -USE_MDFILE_AS_MAINPAGE = user_guide.md +USE_MDFILE_AS_MAINPAGE = vcoord_gen.md #--------------------------------------------------------------------------- # Configuration options related to source browsing diff --git a/sorc/vcoord_gen.fd/docs/README.md b/sorc/vcoord_gen.fd/docs/README.md new file mode 100644 index 000000000..238d5b850 --- /dev/null +++ b/sorc/vcoord_gen.fd/docs/README.md @@ -0,0 +1,4 @@ +This program generates the parameters needed to define +the forecast model's hybrid levels. + +Documentation may be found at https://ufs-community.github.io/UFS_UTILS diff --git a/sorc/vcoord_gen.fd/docs/user_guide.md b/sorc/vcoord_gen.fd/docs/vcoord_gen.md similarity index 100% rename from sorc/vcoord_gen.fd/docs/user_guide.md rename to sorc/vcoord_gen.fd/docs/vcoord_gen.md