Fixing some doxygen documentation - first pass

cpl/module_cap_cpl.F90

@@ -1,10 +1,14 @@
+!> @file
+!> @brief This module contains the the debug subroutines for fv3 coupled run
+!> @author ???
+!>
+!> ## Module History
+!>
+!> Date | Programmer | Modification
+!> -----|------------|-------------
+!> 12 Mar 2018 | J. Wang | Pull coupled subroutines from fv3_cap.F90 to this module
 module module_cap_cpl
-!
-!*** this module contains the debug subroutines for fv3 coupled run
-!
-! revision history
-!  12 Mar 2018: J. Wang       Pull coupled subroutines from fv3_cap.F90 to this module
-!
+
   use ESMF
 
   implicit none
@@ -13,9 +17,17 @@ module module_cap_cpl
   public diagnose_cplFields
   contains
 
-  !-----------------------------------------------------------------------------
-  !-----------------------------------------------------------------------------
-
+    !> ???
+    !> 
+    !> @param[in] gcomp ???
+    !> @param[in] clock_fv3 ???
+    !> @param[in] fcstpe ???
+    !> @param[in] statewrite_flag ???
+    !> @param[in] stdiagnose_flag ???
+    !> @param[in] state_tag "import" or "export"
+    !> @param[out] rc ???
+    !>
+    !> @author
     subroutine diagnose_cplFields(gcomp, clock_fv3, fcstpe, &
                                   statewrite_flag, stdiagnose_flag, state_tag, rc)
 
@@ -79,9 +91,15 @@ subroutine diagnose_cplFields(gcomp, clock_fv3, fcstpe, &
 
     end subroutine diagnose_cplFields
 
-  !-----------------------------------------------------------------------------
-
-  ! This subroutine requires ESMFv8 - for coupled FV3
+    !> ???
+    !> 
+    !> This subroutine requires ESMFv8 - for coupled FV3
+    !>
+    !> @param[in] state ???
+    !> @param[in] filename ???
+    !> @param[out] rc ???
+    !>
+    !> @author
     subroutine State_RWFields_tiles(state,filename,rc)
 
       type(ESMF_State), intent(in)          :: state
@@ -254,6 +272,13 @@ subroutine State_RWFields_tiles(state,filename,rc)
 
     contains
 
+      !> ???
+      !>
+      !> @param[in] axis ???
+      !> @param[in] count ???
+      !> @result id ???
+      !>
+      !> @author
       function find_axis_id_for_axis_count(axis, count) result(id)
         integer, intent(in) :: axis, count
 
@@ -286,8 +311,13 @@ end function find_axis_id_for_axis_count
 
     end subroutine State_RWFields_tiles
 
-  !-----------------------------------------------------------------------------
-
+  !> ???
+  !> 
+  !> @param[in] State ???
+  !> @param[in] string ???
+  !> @param[out] rc ???
+  !>
+  !> @author
   subroutine state_diagnose(State,string, rc)
     ! ----------------------------------------------
     ! Diagnose status of state
@@ -371,6 +401,4 @@ subroutine state_diagnose(State,string, rc)
 
   end subroutine state_diagnose
 
-  !-----------------------------------------------------------------------------
-
 end module module_cap_cpl

cpl/module_cplfields.F90

@@ -1,20 +1,19 @@
+!> @file
+!> @brief This module contains the fv3 Coupling Fields: export and import
+!> @author ???
 module module_cplfields
 
-  !-----------------------------------------------------------------------------
-  ! This module contains the fv3 Coupling Fields: export and import
-  !
-  !-----------------------------------------------------------------------------
-
   use ESMF
   use NUOPC
 
   implicit none
 
   private
 
+  !> ???
   type, public :: FieldInfo
-    character(len=41) :: name
-    character(len=1) :: type
+    character(len=41) :: name !< ???
+    character(len=1) :: type !< ???
   end type
 
 ! Export Fields ----------------------------------------
@@ -26,9 +25,10 @@ module module_cplfields
   !  l : model levels (3D)
   !  s : surface (2D)
   !  t : tracers (4D)
-  integer,          public, parameter :: NexportFields = 121
-  type(ESMF_Field), target, public    :: exportFields(NexportFields)
+  integer,          public, parameter :: NexportFields = 121 !< ???
+  type(ESMF_Field), target, public    :: exportFields(NexportFields) !< ???
 
+  !> ???
   type(FieldInfo), dimension(NexportFields), public, parameter :: exportFieldsInfo = [ &
     FieldInfo("inst_pres_interface                      ", "i"), &
     FieldInfo("inst_pres_levels                         ", "l"), &
@@ -158,10 +158,11 @@ module module_cplfields
     FieldInfo("cpl_scalars                              ", "s")]
 
 ! Import Fields ----------------------------------------
-  integer,          public, parameter :: NimportFields = 67
-  logical,          public            :: importFieldsValid(NimportFields)
-  type(ESMF_Field), target, public    :: importFields(NimportFields)
+  integer,          public, parameter :: NimportFields = 67 !< ???
+  logical,          public            :: importFieldsValid(NimportFields) !< ???
+  type(ESMF_Field), target, public    :: importFields(NimportFields) !< ???
 
+  !> ???
   type(FieldInfo), dimension(NimportFields), public, parameter :: importFieldsInfo = [ &
     FieldInfo("inst_tracer_mass_frac                    ", "t"), &
     FieldInfo("land_mask                                ", "s"), &
@@ -241,7 +242,7 @@ module module_cplfields
     FieldInfo("evap_fire                                ", "s"), &
     FieldInfo("smoke_fire                               ", "s") ]
 
-! Fields exported exclusively for coupling with chemistry
+  !> Fields exported exclusively for coupling with chemistry
   character(*), public, parameter :: chemistryFieldNames(*) = [ &
     "inst_pres_interface             ", &
     "inst_pres_levels                ", &
@@ -282,9 +283,15 @@ module module_cplfields
   public cplFieldGet
   public realizeConnectedCplFields
 
-!-----------------------------------------------------------------------------
   contains
-!-----------------------------------------------------------------------------
+
+  !> ???
+  !> 
+  !> @param[in] fieldname ???
+  !> @param[in] abortflag ???
+  !> @return ???
+  !>
+  !> @author
   integer function queryExportFields(fieldname, abortflag)
 
     character(len=*),intent(in) :: fieldname
@@ -294,8 +301,13 @@ integer function queryExportFields(fieldname, abortflag)
 
   end function queryExportFields
 
-!-----------------------------------------------------------------------------
-
+  !> ???
+  !> 
+  !> @param[in] fieldname ???
+  !> @param[in] abortflag ???
+  !> @return ???
+  !>
+  !> @author
   integer function queryImportFields(fieldname, abortflag)
 
     character(len=*),intent(in) :: fieldname
@@ -305,8 +317,14 @@ integer function queryImportFields(fieldname, abortflag)
 
   end function queryImportFields
 
-!-----------------------------------------------------------------------------
-
+  !> ???
+  !> 
+  !> @param[in] fieldsInfo ???
+  !> @param[in] fieldname ???
+  !> @param[in] abortflag ???
+  !> @return ???
+  !>
+  !> @author
   integer function queryFieldList(fieldsInfo, fieldname, abortflag)
     ! returns integer index of first found fieldname in fieldlist
     ! by default, will abort if field not found, set abortflag to false
@@ -343,8 +361,14 @@ integer function queryFieldList(fieldsInfo, fieldname, abortflag)
     endif
   end function queryFieldList
 
-!-----------------------------------------------------------------------------
-
+  !> ???
+  !> 
+  !> @param[in] state ???
+  !> @param[in] fieldList ???
+  !> @param[out] fieldCount ???
+  !> @param[out] rc ???
+  !>
+  !> @author
   subroutine cplStateGet(state, fieldList, fieldCount, rc)
 
     character(len=*), intent(in)            :: state
@@ -371,8 +395,17 @@ subroutine cplStateGet(state, fieldList, fieldCount, rc)
 
   end subroutine cplStateGet
 
-!-----------------------------------------------------------------------------
-
+  !> ???
+  !> 
+  !> @param[in] state ???
+  !> @param[in] name ???
+  !> @param[in] localDe ???
+  !> @param[in] farrayPtr2d ???
+  !> @param[in] farrayPtr3d ???
+  !> @param[in] farrayPtr4d ???
+  !> @param[out] rc ???
+  !>
+  !> @author
   subroutine cplFieldGet(state, name, localDe, &
                          farrayPtr2d, farrayPtr3d, farrayPtr4d, rc)
 
@@ -441,7 +474,20 @@ subroutine cplFieldGet(state, name, localDe, &
 
   end subroutine cplFieldGet
 
-
+  !> ???
+  !> 
+  !> @param[inout] state ???
+  !> @param[in] grid ???
+  !> @param[in] numLevels ???
+  !> @param[in] numSoilLayers ???
+  !> @param[in] numTracers ???
+  !> @param[in] fields_info ???
+  !> @param[in] state_tag ???
+  !> @param[out] fieldList ???
+  !> @param[in] fill_value ???
+  !> @param[out] rc ???
+  !>
+  !> @author
   subroutine realizeConnectedCplFields(state, grid, &
                                        numLevels, numSoilLayers, numTracers, &
                                        fields_info, state_tag, fieldList, fill_value, rc)
@@ -565,8 +611,15 @@ subroutine realizeConnectedCplFields(state, grid, &
 
   end subroutine realizeConnectedCplFields
 
-!-----------------------------------------------------------------------------
-
+  !> ???
+  !> 
+  !> @param[in] field ???
+  !> @param[in] key ???
+  !> @param[in] numLevels ???
+  !> @param[in] values ???
+  !> @param[out] rc ???
+  !>
+  !> @author
   subroutine addFieldMetadata(field, key, values, rc)
 
     ! This subroutine implements a preliminary method to provide metadata to
@@ -601,6 +654,5 @@ subroutine addFieldMetadata(field, key, values, rc)
 
   end subroutine addFieldMetadata
 !
-!------------------------------------------------------------------------------
 !
 end module module_cplfields

cpl/module_cplscalars.F90

@@ -26,13 +26,14 @@ module module_cplscalars
   public State_GetScalar
 
   ! set from config
-  integer, public           :: flds_scalar_num, flds_scalar_index_nx
-  integer, public           :: flds_scalar_index_ny, flds_scalar_index_ntile
-  character(len=80), public :: flds_scalar_name
+  integer, public           :: flds_scalar_num !< ???
+  integer, public           :: flds_scalar_index_nx !< ???
+  integer, public           :: flds_scalar_index_ny !< ???
+  integer, public           :: flds_scalar_index_ntile !< ???
+  character(len=80), public :: flds_scalar_name !< ???
 
 contains
 
-  !================================================================================
   !> Create a scalar field
   !>
   !> @param[inout]   field            an ESMF_Field
@@ -71,7 +72,6 @@ subroutine SetScalarField(field, flds_scalar_name, flds_scalar_num, rc)
 
   end subroutine SetScalarField
 
-  !================================================================================
   !> Set scalar data into a state
   !>
   !> @param[inout]   State            an ESMF_State
@@ -126,7 +126,6 @@ subroutine State_SetScalar(scalar_value, scalar_id, State, flds_scalar_name, fld
 
   end subroutine State_SetScalar
 
-  !===============================================================================
   !> Get scalar data from a state
   !>
   !> @details Obtain the field flds_scalar_name from a State and broadcast and

docs/Doxyfile.in

@@ -827,7 +827,7 @@ WARN_IF_DOC_ERROR      = YES
 # EXTRACT_ALL is set to YES then this flag will automatically be disabled.
 # The default value is: NO.
 
-WARN_NO_PARAMDOC       = NO
+WARN_NO_PARAMDOC       = YES
 
 # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
 # a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS