diff --git a/src/ip_equid_cylind_grid_mod.F90 b/src/ip_equid_cylind_grid_mod.F90 index e2e3289a..fc387987 100644 --- a/src/ip_equid_cylind_grid_mod.F90 +++ b/src/ip_equid_cylind_grid_mod.F90 @@ -32,9 +32,12 @@ module ip_equid_cylind_grid_mod real :: dlat !< Di — i direction increment. GRIB2, Section 3, octets 64-67. real :: dlon !< Dj — j direction increment. GRIB2, Section 3, octets 68-71. contains - procedure :: init_grib1 !< Init GRIB1. @return N/A - procedure :: init_grib2 !< Init GRIB2. @return N/A - procedure :: gdswzd => gdswzd_equid_cylind !< See gdswzd_equid_cylind(). @return N/A + !> @return N/A @copydoc ip_equid_cylind_grid_mod::init_grib1 + procedure :: init_grib1 !< Init GRIB1. + !> @return N/A @copydoc ip_equid_cylind_grid_mod::init_grib2 + procedure :: init_grib2 !< Init GRIB2. + !> @return N/A @copydoc ip_equid_cylind_grid_mod::gdswzd_equid_cylind + procedure :: gdswzd => gdswzd_equid_cylind end type ip_equid_cylind_grid REAL :: DLAT !< Grid resolution in degrees n/s direction. diff --git a/src/ip_gaussian_grid_mod.F90 b/src/ip_gaussian_grid_mod.F90 index e5438b49..2d495410 100644 --- a/src/ip_gaussian_grid_mod.F90 +++ b/src/ip_gaussian_grid_mod.F90 @@ -32,12 +32,15 @@ module ip_gaussian_grid_mod integer :: jg !< Number of parallels between the equator and pole times 2. GRIB2 Section 3, octets 68-71. integer :: jscan !< Scanning mode in the 'j' direction. GRIB2 Section 3, octet 72. contains - !> Initializes a gaussian grid given a grib1_descriptor object. @return N/A + !> Initializes a gaussian grid given a grib1_descriptor object. + !> @return N/A @copydoc ip_gaussian_grid_mod::init_grib1 procedure :: init_grib1 - !> Initializes a gaussian grid given a grib2_descriptor object. @return N/A + !> Initializes a gaussian grid given a grib2_descriptor object. + !> @return N/A @copydoc ip_gaussian_grid_mod::init_grib2 procedure :: init_grib2 !> Calculates Earth coordinates (iopt = 1) or grid coorindates (iopt = -1) - !> for Gaussian grids. @return N/A + !> for Gaussian grids. + !> @return N/A @copydoc ip_gaussian_grid_mod::gdswzd_gaussian procedure :: gdswzd => gdswzd_gaussian end type ip_gaussian_grid diff --git a/src/ip_grid_descriptor_mod.F90 b/src/ip_grid_descriptor_mod.F90 index 5084f474..73cf27da 100644 --- a/src/ip_grid_descriptor_mod.F90 +++ b/src/ip_grid_descriptor_mod.F90 @@ -28,7 +28,8 @@ module ip_grid_descriptor_mod type, abstract :: ip_grid_descriptor integer :: grid_num !< Integer representing the grid type (see *_GRID_ID_GRIB1/2 in ip_grid_mod). contains - !> Test whether two grid descriptors are the same. @return N/A + !> Test whether two grid descriptors are the same. + !> @return N/A @copydoc ip_grid_descriptor_mod::is_same_grid procedure :: is_same_grid end type ip_grid_descriptor @@ -38,7 +39,8 @@ module ip_grid_descriptor_mod type, extends(ip_grid_descriptor) :: grib1_descriptor integer :: gds(200) !< Grib-1 grib descriptor section (GDS) contains - !> Test whether two grid descriptors are the same. @return N/A + !> Test whether two grid descriptors are the same. + !> @return N/A @copydoc ip_grid_descriptor_mod::is_same_grid_grib1 procedure :: is_same_grid_grib1 end type grib1_descriptor @@ -49,7 +51,8 @@ module ip_grid_descriptor_mod integer :: gdt_len !< Length of the template. integer, allocatable :: gdt_tmpl(:) !< Grib-2 grid definition template. contains - !> Test whether two grid descriptors are the same. @return N/A + !> Test whether two grid descriptors are the same. + !> @return N/A @copydoc ip_grid_descriptor_mod::is_same_grid_grib2 procedure :: is_same_grid_grib2 end type grib2_descriptor diff --git a/src/ip_grid_mod.F90 b/src/ip_grid_mod.F90 index c428e1a2..b460636b 100644 --- a/src/ip_grid_mod.F90 +++ b/src/ip_grid_mod.F90 @@ -77,14 +77,17 @@ module ip_grid_mod real :: rerth !< Radius of the Earth. real :: eccen_squared !< Eccentricity of the Earth squared (e^2). contains - !> Initializer for grib1 input descriptor. @return N/A + !> @cond + !> Initializer for grib1 input descriptor. procedure(init_grib1_interface), deferred :: init_grib1 - !> Initializer for grib2 input descriptor. @return N/A + !> Initializer for grib2 input descriptor. procedure(init_grib2_interface), deferred :: init_grib2 - !> Coordinate transformations for the grid. @return N/A + !> Coordinate transformations for the grid. procedure(gdswzd_interface), deferred :: gdswzd + !> @endcond !> Field position for a given grid point. @return Integer !> position in grib field to locate grid point. + !> @copydoc ip_grid_mod::field_pos procedure :: field_pos !> Init subprogram. @return N/A generic :: init => init_grib1, init_grib2 diff --git a/src/ip_lambert_conf_grid_mod.F90 b/src/ip_lambert_conf_grid_mod.F90 index 7063256e..ea0732d9 100644 --- a/src/ip_lambert_conf_grid_mod.F90 +++ b/src/ip_lambert_conf_grid_mod.F90 @@ -32,12 +32,15 @@ module ip_lambert_conf_grid_mod real :: h !< Hemisphere flag. 1-NH, minus 1-SH. integer :: irot !< vector rotation flag. When "1", vectors are grid relative. When "0", vectors are earth relative. GRIB2, Section 3, octet 55. contains - !> Initializes a gaussian grid given a grib1_descriptor object. @return N/A + !> Initializes a gaussian grid given a grib1_descriptor object. + !> @return N/A @copydoc ip_lambert_conf_grid_mod::init_grib1 procedure :: init_grib1 - !> Initializes a gaussian grid given a grib2_descriptor object. @return N/A + !> Initializes a gaussian grid given a grib2_descriptor object. + !> @return N/A @copydoc ip_lambert_conf_grid_mod::init_grib2 procedure :: init_grib2 !> Calculates Earth coordinates (iopt = 1) or grid coorindates (iopt = -1) - !> for Gaussian grids. @return N/A + !> for Gaussian grids. + !> @return N/A @copydoc ip_lambert_conf_grid_mod::gdswzd_lambert_conf procedure :: gdswzd => gdswzd_lambert_conf end type ip_lambert_conf_grid diff --git a/src/ip_mercator_grid_mod.F90 b/src/ip_mercator_grid_mod.F90 index 937fddf2..42cb0610 100644 --- a/src/ip_mercator_grid_mod.F90 +++ b/src/ip_mercator_grid_mod.F90 @@ -28,13 +28,16 @@ module ip_mercator_grid_mod real :: dlon !< Longitudinal direction grid length. Section 3, octets 65-68. real :: dphi !< Latitudinal direction grid length. Section 3, octets 69-72. contains - !> Initializes a gaussian grid given a grib1_descriptor object. @return N/A + !> Initializes a gaussian grid given a grib1_descriptor object. + !> @return N/A @copydoc ip_mercator_grid_mod::init_grib1 procedure :: init_grib1 - !> Initializes a gaussian grid given a grib2_descriptor object. @return N/A + !> Initializes a gaussian grid given a grib2_descriptor object. + !> @return N/A @copydoc ip_mercator_grid_mod::init_grib2 procedure :: init_grib2 !> Calculates Earth coordinates (iopt = 1) or grid coorindates (iopt = -1) - !> for Gaussian grids. @return N/A - procedure :: gdswzd => gdswzd_mercator !< gdswzd() @return N/A + !> for Gaussian grids. + !> @return N/A @copydoc ip_mercator_grid_mod::gdswzd_mercator + procedure :: gdswzd => gdswzd_mercator end type ip_mercator_grid REAL :: DLON !< Longitudinal direction grid length. diff --git a/src/ip_polar_stereo_grid_mod.F90 b/src/ip_polar_stereo_grid_mod.F90 index 7aa994f3..250445f1 100644 --- a/src/ip_polar_stereo_grid_mod.F90 +++ b/src/ip_polar_stereo_grid_mod.F90 @@ -34,10 +34,15 @@ module ip_polar_stereo_grid_mod !> relative. integer :: irot contains - procedure :: init_grib1 !< Initializes a grid given a grib1_descriptor object. @return N/A - procedure :: init_grib2 !< Initializes a grid given a grib2_descriptor object. @return N/A + !> Initializes a grid given a grib1_descriptor object. + !> @return N/A @copydoc ip_polar_stereo_grid_mod::init_grib1 + procedure :: init_grib1 + !> Initializes a grid given a grib2_descriptor object. + !> @return N/A @copydoc ip_polar_stereo_grid_mod::init_grib2 + procedure :: init_grib2 !> Calculates Earth coordinates (iopt = 1) or grid coorindates - !> (iopt = -1). @return N/A + !> (iopt = -1). + !> @return N/A @copydoc ip_polar_stereo_grid_mod::gdswzd_polar_stereo procedure :: gdswzd => gdswzd_polar_stereo end type ip_polar_stereo_grid diff --git a/src/ip_rot_equid_cylind_egrid_mod.F90 b/src/ip_rot_equid_cylind_egrid_mod.F90 index c0c425f8..4e7d39cd 100644 --- a/src/ip_rot_equid_cylind_egrid_mod.F90 +++ b/src/ip_rot_equid_cylind_egrid_mod.F90 @@ -49,13 +49,16 @@ module ip_rot_equid_cylind_egrid_mod integer :: irot contains !> Initializes a rotated equidistant cylindrical grid given a - !> grib1_descriptor object. @return N/A + !> grib1_descriptor object. + !> @return N/A @copydoc ip_rot_equid_cylind_egrid_mod::init_grib1 procedure :: init_grib1 !> Initializes a rotated equidistant cylindrical grid given a - !> grib2_descriptor object. @return N/A + !> grib2_descriptor object. + !> @return N/A @copydoc ip_rot_equid_cylind_egrid_mod::init_grib2 procedure :: init_grib2 !> Calculates Earth coordinates (iopt = 1) or grid coorindates - !> (iopt = -1). @return N/A + !> (iopt = -1). + !> @return N/A @copydoc ip_rot_equid_cylind_egrid_mod::gdswzd_rot_equid_cylind_egrid procedure :: gdswzd => gdswzd_rot_equid_cylind_egrid end type ip_rot_equid_cylind_egrid diff --git a/src/ip_rot_equid_cylind_grid_mod.F90 b/src/ip_rot_equid_cylind_grid_mod.F90 index e3fcb488..0f756410 100644 --- a/src/ip_rot_equid_cylind_grid_mod.F90 +++ b/src/ip_rot_equid_cylind_grid_mod.F90 @@ -43,13 +43,16 @@ module ip_rot_equid_cylind_grid_mod integer :: irot contains !> Initializes a Rotated equidistant cylindrical grid given a - !> grib1_descriptor object. @return N/A + !> grib1_descriptor object. + !> @return N/A @copydoc ip_rot_equid_cylind_grid_mod::init_grib1 procedure :: init_grib1 !> Initializes a Rotated equidistant cylindrical given a - !> grib2_descriptor object. @return N/A + !> grib2_descriptor object + !> @return N/A @copydoc ip_rot_equid_cylind_grid_mod::init_grib2 procedure :: init_grib2 !> Calculates Earth coordinates (iopt = 1) or grid coorindates (iopt = -1) - !> for Gaussian grids. @return N/A + !> for Gaussian grids. + !> @return N/A @copydoc ip_rot_equid_cylind_grid_mod::gdswzd_rot_equid_cylind procedure :: gdswzd => gdswzd_rot_equid_cylind end type ip_rot_equid_cylind_grid diff --git a/src/ip_station_points_grid_mod.F90 b/src/ip_station_points_grid_mod.F90 index 165daccf..e0215878 100644 --- a/src/ip_station_points_grid_mod.F90 +++ b/src/ip_station_points_grid_mod.F90 @@ -17,12 +17,15 @@ module ip_station_points_grid_mod type, extends(ip_grid) :: ip_station_points_grid contains - !> Initializes a gaussian grid given a grib1_descriptor object. @return N/A + !> Initializes a gaussian grid given a grib1_descriptor object. + !> @return N/A @copydoc ip_station_points_grid_mod::init_grib1 procedure :: init_grib1 - !> Initializes a gaussian grid given a grib2_descriptor object. @return N/A + !> Initializes a gaussian grid given a grib2_descriptor object. + !> @return N/A @copydoc ip_station_points_grid_mod::init_grib2 procedure :: init_grib2 !> Calculates Earth coordinates (iopt = 1) or grid coorindates (iopt = -1) - !> for IP Station Point grids. @return N/A + !> for IP Station Point grids. + !> @return N/A @copydoc ip_station_points_grid_mod::gdswzd_station_points procedure :: gdswzd => GDSWZD_station_points end type ip_station_points_grid