Skip to content

Commit

Permalink
Fix Doxygen comments
Browse files Browse the repository at this point in the history
Add additional Doxygen syntax as per Ryan's review comments.
  • Loading branch information
Jesse Lentz committed Jul 23, 2024
1 parent 7455578 commit 0208543
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion field_manager/fm_yaml.F90
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
!* You should have received a copy of the GNU Lesser General Public
!* License along with FMS. If not, see <http://www.gnu.org/licenses/>.
!***********************************************************************

!> @defgroup fm_yaml_mod fm_yaml_mod
!> @ingroup fm_yaml
!> @brief Reads entries from a field table yaml into a
Expand All @@ -37,10 +38,13 @@ module fm_yaml_mod
implicit none
private

!> @}

public :: build_fmTable

!> @brief This type represents a subparameter block for a given variable parameter.
!> This type contains the name of the associated parameter and the subparameter key/value pairs
!> @ingroup fm_yaml_mod
type, public :: fmAttr_t
integer :: id !< block id of this var
character(len=:), allocatable :: paramname !< name of associated parameter
Expand All @@ -50,7 +54,8 @@ module fm_yaml_mod

!> @brief This type represents the entries for a given variable, e.g. dust.
!> This type contains the name of the variable, the block id, the key/value pairs for the
!! variable's parameters, and any applicable subparameters
!> variable's parameters, and any applicable subparameters
!> @ingroup fm_yaml_mod
type, public :: fmVar_t
integer :: id !< block id of this var
character(len=:), allocatable :: name !< name of the variable
Expand All @@ -61,6 +66,7 @@ module fm_yaml_mod

!> @brief This type represents the entries for a given model, e.g. land, ocean, atmosphere.
!> This type contains the name of the model, the block id, and the variables within this model
!> @ingroup fm_yaml_mod
type, public :: fmModel_t
integer :: id !< block id of this model
character(len=:), allocatable :: name !< name of the model
Expand All @@ -69,19 +75,24 @@ module fm_yaml_mod

!> @brief This type represents the entries for a specific field type, e.g. a tracer.
!> This type contains the name of the field type, the block id, and the models within this field type
!> @ingroup fm_yaml_mod
type, public :: fmType_t
integer :: id !< block id of this type
character(len=:), allocatable :: name !< name of the type
type (fmModel_t), allocatable :: models(:) !< models in this type
end type fmType_t

!> @brief This type contains the field types within a field table.
!> @ingroup fm_yaml_mod
type, public :: fmTable_t
type (fmType_t), allocatable :: types(:) !< field types in this table
end type fmTable_t

contains

!> @addtogroup fm_yaml_mod
!> @{

!> @brief Subroutine to populate an fmTable by reading a yaml file, given an optional filename.
subroutine build_fmTable(fmTable, filename)
type(fmTable_t), intent(out) :: fmTable !< the field table
Expand Down

0 comments on commit 0208543

Please sign in to comment.