From d93c3cd974c362adf49fcd946ebf1b2856a5e4b4 Mon Sep 17 00:00:00 2001 From: Jesse Lentz Date: Wed, 30 Aug 2023 09:54:10 -0400 Subject: [PATCH] Add comments and move `module`/`module end` statements Comments have been added to the tops of `data_override.F90` and `data_override.inc`. The `module` and `module end` statements have been moved from the .fh files to `data_override.F90`. --- data_override/data_override.F90 | 9 +++++++++ data_override/include/data_override.inc | 4 ++++ data_override/include/data_override_r4.fh | 2 -- data_override/include/data_override_r8.fh | 2 -- 4 files changed, 13 insertions(+), 4 deletions(-) diff --git a/data_override/data_override.F90 b/data_override/data_override.F90 index ff79e35e45..8ea6b1a6d1 100644 --- a/data_override/data_override.F90 +++ b/data_override/data_override.F90 @@ -17,8 +17,17 @@ !* License along with FMS. If not, see . !*********************************************************************** +! data_override_r4 and data_override_r8 are not intended to be used directly - +! they should be used through the data_override_mod API. The body of +! data_override_r4 and data_override_r8 is contained in data_override.inc. + +module data_override_r4 #include "data_override_r4.fh" +end module data_override_r4 + +module data_override_r8 #include "data_override_r8.fh" +end module data_override_r8 !> @defgroup data_override_mod data_override_mod !> @ingroup data_override diff --git a/data_override/include/data_override.inc b/data_override/include/data_override.inc index 0a5463efcc..1cf94b49cc 100644 --- a/data_override/include/data_override.inc +++ b/data_override/include/data_override.inc @@ -17,6 +17,10 @@ !* License along with FMS. If not, see . !*********************************************************************** +! This file contains the body of the data_override_r4 and data_override_r8 +! modules. These modules are not intended to be used directly - they should be +! used through the data_override_mod API. See data_override.F90 for details. + use platform_mod, only: r4_kind, r8_kind use yaml_parser_mod use constants_mod, only: DEG_TO_RAD diff --git a/data_override/include/data_override_r4.fh b/data_override/include/data_override_r4.fh index 45eb43b4ce..c61fc3d853 100644 --- a/data_override/include/data_override_r4.fh +++ b/data_override/include/data_override_r4.fh @@ -50,9 +50,7 @@ #undef DATA_OVERRIDE_UG_2D_ #define DATA_OVERRIDE_UG_2D_ data_override_ug_2d_r4 -module data_override_r4 #include "data_override.inc" -end module data_override_r4 #undef FMS_DATA_OVERRIDE_KIND_ #undef DATA_OVERRIDE_INIT_IMPL_ diff --git a/data_override/include/data_override_r8.fh b/data_override/include/data_override_r8.fh index efe3df45ad..1d7cfc9a97 100644 --- a/data_override/include/data_override_r8.fh +++ b/data_override/include/data_override_r8.fh @@ -50,9 +50,7 @@ #undef DATA_OVERRIDE_UG_2D_ #define DATA_OVERRIDE_UG_2D_ data_override_ug_2d_r8 -module data_override_r8 #include "data_override.inc" -end module data_override_r8 #undef FMS_DATA_OVERRIDE_KIND_ #undef DATA_OVERRIDE_INIT_IMPL_