more doxygen

NOAA-EMC · Jan 19, 2024 · 03e35a0 · 03e35a0
1 parent 9e00ad6
commit 03e35a0
Showing 1 changed file with 54 additions and 45 deletions.
diff --git a/io/module_write_internal_state.F90 b/io/module_write_internal_state.F90
@@ -1,16 +1,11 @@
-!-----------------------------------------------------------------------
+!> @file 
+!> @brief Internal state of the write component.
+!> @author J. Wang/G. Theurich @date Feb, 2017
+
+!> @brief Internal state of the write component.
+!>
+!> @author Jun Wang @date Feb, 2017
       module write_internal_state
-!
-!-----------------------------------------------------------------------
-!***  the internal state of the write component.
-!-----------------------------------------------------------------------
-!***
-!***  revision history
-!***
-!       Feb 2017:  J. Wang - Initial code
-!
-!-----------------------------------------------------------------------
-!
       use esmf
 !
 !-----------------------------------------------------------------------
@@ -20,12 +15,27 @@ module write_internal_state
 !-----------------------------------------------------------------------
 !
       type output_grid_info
-        integer :: im, jm, lm
-        integer :: i_start,i_end, j_start,j_end
-        real,dimension(:,:),allocatable  :: lonPtr, latPtr
-        integer,dimension(:),allocatable :: i_start_wrtgrp, i_end_wrtgrp, j_start_wrtgrp, j_end_wrtgrp
-        real    :: latse, latnw, lonse, lonnw
-        real    :: latstart, latlast, lonstart, lonlast
+        integer :: im !< ???
+        integer :: jm !< ???
+        integer :: lm !< ???
+        integer :: i_start !< ???
+        integer :: i_end !< ???
+        integer :: j_start !< ???
+        integer :: j_end !< ???
+        real,dimension(:,:),allocatable  :: lonPtr !< ???
+        real,dimension(:,:),allocatable  :: latPtr !< ???
+        integer,dimension(:),allocatable :: i_start_wrtgrp !< ???
+        integer,dimension(:),allocatable :: i_end_wrtgrp !< ???
+        integer,dimension(:),allocatable :: j_start_wrtgrp !< ???
+        integer,dimension(:),allocatable :: j_end_wrtgrp !< ???
+        real    :: latse !< ???
+        real    :: latnw !< ???
+        real    :: lonse !< ???
+        real    :: lonnw !< ???
+        real    :: latstart !< ???
+        real    :: latlast !< ???
+        real    :: lonstart !< ???
+        real    :: lonlast !< ???
       end type output_grid_info
 
       type wrt_internal_state
@@ -34,72 +44,71 @@ module write_internal_state
 ! pe information and task layout
 !--------------------------------
 !
-      integer :: mype
-      integer :: petcount
+      integer :: mype !< ???
+      integer :: petcount !< ???
 !
 !--------------------
 !*** grid information
 !--------------------
-      type(esmf_grid) :: wrtgrid
+      type(esmf_grid) :: wrtgrid !< ???
 
-      type(output_grid_info) ,dimension(:), allocatable :: out_grid_info
+      type(output_grid_info) ,dimension(:), allocatable :: out_grid_info !< ???
 !
 !--------------------------
 !*** file bundle for output
 !--------------------------
-      integer :: FBCount
+      integer :: FBCount !< ???
 !
 !-----------------------------------------------------------------------
 !***  THE OUTPUT FILE
 !-----------------------------------------------------------------------
 !
-      integer                 :: num_files
+      integer                 :: num_files !< ???
 !
 !-----------------------------------------------------------------------
 !***  THE OUTPUT FILE
 !-----------------------------------------------------------------------
 !
-      type(ESMF_FieldBundle),dimension(:),allocatable  :: wrtFB
+      type(ESMF_FieldBundle),dimension(:),allocatable  :: wrtFB !< ???
 !
 !-------------------------------------
 !***  Times used in history filenames
 !-------------------------------------
 !
-      type(ESMF_Time)         :: io_basetime
-      integer                 :: idate(7)
-      integer                 :: fdate(7)
+      type(ESMF_Time)         :: io_basetime !< ???
+      integer                 :: idate(7) !< ???
+      integer                 :: fdate(7) !< ???
 !
 !-----------------------------------------
 !***  I/O direction flags (Read or Write)
 !-----------------------------------------
 !
-      logical :: output_history
+      logical :: output_history !< ???
 !
 !-----------------------------------------
 !***  POST flags and required variables
 !-----------------------------------------
 !
-      logical                  :: write_dopost
-      character(80)            :: post_namelist
-!
-      integer                  :: fhzero
-      integer                  :: ntrac
-      integer                  :: ncld
-      integer                  :: nsoil
-      integer                  :: imp_physics
-      integer                  :: dtp
-      real,dimension(:),allocatable :: ak,bk
+      logical                  :: write_dopost !< ???
+      character(80)            :: post_namelist !< ???
+!
+      integer                  :: fhzero !< ???
+      integer                  :: ntrac !< ???
+      integer                  :: ncld !< ???
+      integer                  :: nsoil !< ???
+      integer                  :: imp_physics !< ???
+      integer                  :: dtp !< ???
+      real,dimension(:),allocatable :: ak !< ???
+      real,dimension(:),allocatable :: bk !< ???
 !-----------------------------------------------------------------------
 !
       end type wrt_internal_state
 !
-!-----------------------------------------------------------------------
-!***  THIS STATE IS SUPPORTED BY C POINTERS BUT NOT F90 POINTERS
-!***  THEREFORE WE NEED THIS WRAP.
-!-----------------------------------------------------------
-!
+
+      !> This state is supported by c pointers but not f90 pointers
+      !> therefore we need this wrap.
       type write_wrap
-        type(wrt_internal_state),pointer :: write_int_state
+        type(wrt_internal_state),pointer :: write_int_state  !< ???
       end type write_wrap
 
 !-----------------------------------------------------------