improved documentation

This commit is contained in:
Martin Diehl 2023-02-14 17:37:43 +01:00
parent 3eb9545573
commit 0698c17ff2
1 changed files with 6 additions and 6 deletions

View File

@ -90,7 +90,7 @@ end function YAML_parse_str_asDict
!-------------------------------------------------------------------------------------------------- !--------------------------------------------------------------------------------------------------
!> @brief reads the flow style string and stores it in the form of dictionaries, lists and scalars. !> @brief Read the flow style string and store it in the form of dictionaries, lists and scalars.
!> @details A node type pointer can either point to a dictionary, list or scalar type entities. !> @details A node type pointer can either point to a dictionary, list or scalar type entities.
!-------------------------------------------------------------------------------------------------- !--------------------------------------------------------------------------------------------------
recursive function parse_flow(YAML_flow) result(node) recursive function parse_flow(YAML_flow) result(node)
@ -158,7 +158,7 @@ end function parse_flow
!-------------------------------------------------------------------------------------------------- !--------------------------------------------------------------------------------------------------
!> @brief finds location of chunk end: ',' or '}' or ']' !> @brief Find location of chunk end: ',' or '}' or ']'.
!> @details leaves nested lists ( '[...]' and dicts '{...}') intact !> @details leaves nested lists ( '[...]' and dicts '{...}') intact
!-------------------------------------------------------------------------------------------------- !--------------------------------------------------------------------------------------------------
integer function find_end(str,e_char) integer function find_end(str,e_char)
@ -188,7 +188,7 @@ end function find_end
!-------------------------------------------------------------------------------------------------- !--------------------------------------------------------------------------------------------------
! @brief check whether a string is enclosed with single or double quotes ! @brief Check whether a string is enclosed with single or double quotes.
!-------------------------------------------------------------------------------------------------- !--------------------------------------------------------------------------------------------------
logical function quotedString(line) logical function quotedString(line)
@ -254,7 +254,7 @@ end function indentDepth
!-------------------------------------------------------------------------------------------------- !--------------------------------------------------------------------------------------------------
! @brief check whether a string is in flow style, i.e. starts with '{' or '[' ! @brief Check whether a string is in flow style, i.e. starts with '{' or '['
!-------------------------------------------------------------------------------------------------- !--------------------------------------------------------------------------------------------------
logical function isFlow(line) logical function isFlow(line)