Update and clarify doxygen comments

J-Lentz · Aug 21, 2023 · e960b14 · e960b14
1 parent eb0137c
commit e960b14
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git a/data_override/data_override.F90 b/data_override/data_override.F90
@@ -87,8 +87,7 @@ module data_override_mod
 
 contains
 
-!> @brief Assign default values for default_table, get domain of component models,
-!! get global grids of component models.
+!> @brief Initialize either data_override_r4 or data_override_r8
 !! Users should call data_override_init before calling data_override
 !!
 !! This subroutine should be called in coupler_init after
@@ -101,9 +100,10 @@ module data_override_mod
 !! operation can be accomplished via multiple calls to data_override_init with
 !! different mode arguments.
 !!
-!! Data_table is initialized here with default values. Users should provide "real" values
-!! that will override the default values. Real values can be given using data_table, each
-!! line of data_table contains one data_entry. Items of data_entry are comma separated.
+!! Data_table is initialized with default values in DATA_OVERRIDE_INIT_IMPL_. Users should
+!! provide "real" values that will override the default values. Real values can be
+!! specified in either data_table or data_table.yaml. Each line of data_table contains one
+!! data_entry. Items of data_entry are comma-separated.
 subroutine data_override_init(Atm_domain_in, Ocean_domain_in, Ice_domain_in, Land_domain_in, Land_domainUG_in, mode)
   type (domain2d), intent(in), optional :: Atm_domain_in !< Atmosphere domain
   type (domain2d), intent(in), optional :: Ocean_domain_in !< Ocean domain

diff --git a/data_override/include/data_override_impl.inc b/data_override/include/data_override_impl.inc
@@ -642,7 +642,7 @@ subroutine DATA_OVERRIDE_0D_IMPL_(gridname,fieldname_code,data,time,override,dat
 
 end subroutine DATA_OVERRIDE_0D_IMPL_
 
-!> @brief This routine performs data override for 2D fields; for usage, see data_override_3d.
+!> @brief This routine performs data override for 2D fields.
 subroutine DATA_OVERRIDE_2D_IMPL_(gridname,fieldname,data_2D,time,override, is_in, ie_in, js_in, je_in)
   character(len=3), intent(in) :: gridname !< model grid ID
   character(len=*), intent(in) :: fieldname !< field to override