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`.
NOAA-GFDL · Aug 30, 2023 · d93c3cd · d93c3cd
1 parent ca0d5ab
commit d93c3cd
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 4 deletions.
diff --git a/data_override/data_override.F90 b/data_override/data_override.F90
@@ -17,8 +17,17 @@
 !* License along with FMS.  If not, see <http://www.gnu.org/licenses/>.
 !***********************************************************************
 
+! 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
@@ -17,6 +17,10 @@
 !* License along with FMS.  If not, see <http://www.gnu.org/licenses/>.
 !***********************************************************************
 
+! 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
@@ -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
@@ -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_