Corrected documentation errors

- Updated Doxygen configuration to find files in config_src/external
neerajabhamidipati · Jun 19, 2020 · 6818402 · 6818402
1 parent b31da6a
commit 6818402
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 8 deletions.
diff --git a/config_src/external/ODA_hooks/ocean_da_types.F90 b/config_src/external/ODA_hooks/ocean_da_types.F90
@@ -51,15 +51,16 @@ module ocean_da_types_mod
      real, pointer, dimension(:,:,:,:) :: S=>NULL() !<layer salinity (psu or g kg-1) across ensembles
      real, pointer, dimension(:,:,:,:) :: U=>NULL() !<layer zonal velocity (m s-1) across ensembles
      real, pointer, dimension(:,:,:,:) :: V=>NULL() !<layer meridional velocity (m s-1) across ensembles
-     integer, dimension(:), pointer :: id_t=>NULL(), id_s=>NULL()  !< diagnostic IDs for temperature and salinity
-     integer, dimension(:), pointer :: id_u=>NULL(), id_v=>NULL()     !< diagnostic IDs for zonal and meridional velocity
+     integer, dimension(:), pointer :: id_t=>NULL(), id_s=>NULL() !< diagnostic IDs for temperature and salinity
+     integer, dimension(:), pointer :: id_u=>NULL(), id_v=>NULL() !< diagnostic IDs for zonal and meridional velocity
      integer, dimension(:), pointer :: id_ssh=>NULL()  !< diagnostic IDs for SSH
   end type OCEAN_CONTROL_STRUCT
 
   !> Profile
   type, public :: ocean_profile_type
      integer :: variable !< variable ids are defined by the ocean_types module (e.g. TEMP_ID, SALT_ID)
-     integer :: inst_type !< instrument types are defined by platform class (e.g. MOORING, DROP, etc.) and instrument type (XBT, CDT, etc.)
+     integer :: inst_type !< instrument types are defined by platform class
+                          !! (e.g. MOORING, DROP, etc.) and instrument type (XBT, CDT, etc.)
      integer :: nvar !< number of observations types associated with the current profile
      real    :: project !< e.g. FGGE, COARE, ACCE, ...
      real    :: probe !< MBT, XBT, drifting buoy
@@ -99,7 +100,8 @@ module ocean_da_types_mod
      type(time_type) :: time
      integer         :: yyyy
      integer         :: mmdd
-     !type(time_type), pointer :: Model_time ! each profile can be associated with a first-guess field with an associated time and grid
+     !type(time_type), pointer :: Model_time ! each profile can be associated
+                                             ! with a first-guess field with an associated time and grid
      !type(grid_type), pointer :: Model_grid
      real :: i_index, j_index ! model longitude and latitude indices respectively
      real, dimension(:), pointer :: k_index ! model depth indices

diff --git a/config_src/external/ODA_hooks/write_ocean_obs.F90 b/config_src/external/ODA_hooks/write_ocean_obs.F90
@@ -31,7 +31,7 @@ integer function open_profile_file(name, nvar, grid_lon, grid_lat,thread,fset)
   real, dimension(:), optional, intent(in) :: grid_lon !< Longitude [degreeE]
   real, dimension(:), optional, intent(in) :: grid_lat !< Latitude [degreeN]
   integer, intent(in), optional :: thread !< Thread
-  integer, intent(in), optional :: fset !< File set 
+  integer, intent(in), optional :: fset !< File set
 
   open_profile_file=-1
 end function open_profile_file

diff --git a/docs/Doxyfile_nortd b/docs/Doxyfile_nortd
@@ -794,7 +794,9 @@ INPUT                  = ../src \
                          front_page.md \
                          ../config_src/solo_driver \
                          ../config_src/dynamic_symmetric
-                         ../config_src/coupled_driver/ocean_model_MOM.F90
+                         ../config_src/external
+                         ../config_src/coupled_driver
+
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

diff --git a/docs/Doxyfile_rtd b/docs/Doxyfile_rtd
@@ -783,8 +783,8 @@ WARN_LOGFILE           = doxygen.log
 INPUT                  = ../src \
                          ../config_src/solo_driver \
                          ../config_src/dynamic_symmetric \
-                         ../config_src/coupled_driver/coupler_util.F90 \
-                         ../config_src/coupled_driver/ocean_model_MOM.F90
+                         ../config_src/external \
+                         ../config_src/coupled_driver
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses