Skip to content

Commit

Permalink
Link to ESMF_TYPEKIND documentation from ESMF_Info API doc.
Browse files Browse the repository at this point in the history
  • Loading branch information
theurich committed Jul 6, 2023
1 parent 76f7875 commit 136ba02
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 4 deletions.
7 changes: 5 additions & 2 deletions scripts/jinja2_templating/templates/Info/ESMF_Info.jinja2
Original file line number Diff line number Diff line change
Expand Up @@ -1043,7 +1043,9 @@ end subroutine ESMF_InfoGetArray{{ t.esmf_suffix }}{% if alloc %}Alloc{% endif %
! An integer index to use. This will index into an object type providing
! the primary mechanism for iteration.
! \item [{[typekind]}]
! Get the ESMF typekind for the target. The minimum typekind required to hold the value is returned.
! Get the ESMF typekind for the target. The minimum typekind required to
! hold the value is returned.
! See section \ref{const:typekind} for valid values.
! \item [{[ikey]}]
! If present, this will be set to the key's name for the current inquire.
! Useful when iterating using an index. This does \textit{not} return the full key
Expand Down Expand Up @@ -1355,7 +1357,8 @@ type(ESMF_KeywordEnforcer), optional:: keywordEnforcer ! must use keywords below
type(ESMF_TypeKind_Flag) :: typekind
!
! !DESCRIPTION:
! Return a value's ESMF TypeKind using a \textit{key}.
! Return the ESMF TypeKind of the value associated with \textit{key}.
! See section \ref{const:typekind} for valid return values.
!
! The arguments are:
! \begin{description}
Expand Down
7 changes: 5 additions & 2 deletions src/Infrastructure/Base/interface/ESMF_Info.F90
Original file line number Diff line number Diff line change
Expand Up @@ -1932,7 +1932,9 @@ end subroutine ESMF_InfoGetArrayLGAlloc
! An integer index to use. This will index into an object type providing
! the primary mechanism for iteration.
! \item [{[typekind]}]
! Get the ESMF typekind for the target. The minimum typekind required to hold the value is returned.
! Get the ESMF typekind for the target. The minimum typekind required to
! hold the value is returned.
! See section \ref{const:typekind} for valid values.
! \item [{[ikey]}]
! If present, this will be set to the key's name for the current inquire.
! Useful when iterating using an index. This does \textit{not} return the full key
Expand Down Expand Up @@ -2253,7 +2255,8 @@ function ESMF_InfoGetTK(info, key, keywordEnforcer, attnestflag, rc) result(type
type(ESMF_TypeKind_Flag) :: typekind
!
! !DESCRIPTION:
! Return a value's ESMF TypeKind using a \textit{key}.
! Return the ESMF TypeKind of the value associated with \textit{key}.
! See section \ref{const:typekind} for valid return values.
!
! The arguments are:
! \begin{description}
Expand Down

0 comments on commit 136ba02

Please sign in to comment.