More doxygen clean-up

NCAR · Dec 19, 2023 · 82a2da3 · 82a2da3
1 parent 2235a02
commit 82a2da3
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 8 deletions.
diff --git a/config_src/external/MARBL/marbl_interface_public_types.F90 b/config_src/external/MARBL/marbl_interface_public_types.F90
@@ -68,6 +68,7 @@ module marbl_interface_public_types
         real, allocatable :: delta_z(:)  !< dummy thicknesses
     end type marbl_domain_type
 
+    !> A non-functioning template of MARBL single output type
     type, public :: marbl_single_output_type
         ! marbl_single_output :
         ! a private type, this contains both the metadata and
@@ -76,12 +77,13 @@ module marbl_interface_public_types
         ! that needs to be passed to the GCM / flux coupler.
         ! Data must be accessed via the marbl_output_for_GCM_type
         ! data structure.
-        real, allocatable, dimension(:)   :: forcing_field_0d
-        real, allocatable, dimension(:,:) :: forcing_field_1d
+        real, allocatable, dimension(:)   :: forcing_field_0d  !< dummy forcing_field_0d
+        real, allocatable, dimension(:,:) :: forcing_field_1d  !< forcing_field_1d
     end type marbl_single_output_type
 
+    !> A non-functioning template of MARBL output for GCM type
     type, public :: marbl_output_for_GCM_type
-        type(marbl_single_output_type), dimension(:), pointer :: outputs_for_GCM => NULL()
+        type(marbl_single_output_type), dimension(:), pointer :: outputs_for_GCM => NULL()  !< dummy outputs_for_GCM
     end type marbl_output_for_GCM_type
 
 end module marbl_interface_public_types
diff --git a/src/tracer/MARBL_forcing_mod.F90 b/src/tracer/MARBL_forcing_mod.F90
@@ -63,9 +63,9 @@ module MARBL_forcing_mod
 end type marbl_forcing_CS
 
 ! Module parameters
-integer, parameter :: atm_co2_constant_iopt = 0
-integer, parameter :: atm_co2_prognostic_iopt = 1
-integer, parameter :: atm_co2_diagnostic_iopt = 2
+integer, parameter :: atm_co2_constant_iopt = 0     !< module parameter denoting atm_co2_opt = 'constant'
+integer, parameter :: atm_co2_prognostic_iopt = 1   !< module parameter denoting atm_co2_opt = 'diagnostic'
+integer, parameter :: atm_co2_diagnostic_iopt = 2   !< module parameter denoting atm_co2_opt = 'prognostic'
 
 contains
 

diff --git a/src/tracer/MARBL_tracers.F90 b/src/tracer/MARBL_tracers.F90
@@ -249,8 +249,8 @@ module MARBL_tracers
                                                          !! (dims: i, j, restoring_nz, restoring_cnt) [tracer units]
 
   !> Number of surface flux outputs as well as specific indices for each one
-  integer :: sfo_cnt
-  integer :: flux_co2_ind
+  integer :: sfo_cnt      !< number of surface flux outputs from MARBL
+  integer :: flux_co2_ind !< index to co2 flux surface flux output
 
   ! TODO: create generic 3D forcing input type to read z coordinate + values
   real    :: fesedflux_scale_factor !< scale factor for iron sediment flux