Skip to content

Commit 195691e

Browse files
jacobwilliamsjacobwilliams
committed
some doc string cleanups
1 parent eed53d3 commit 195691e

File tree

3 files changed

+28
-29
lines changed

3 files changed

+28
-29
lines changed

‎src/json_parameters.F90

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -38,29 +38,29 @@ module json_parameters
3838
integer(IK),parameter :: json_string = 7 !! String JSON data type
3939

4040
!special JSON characters
41-
character(kind=CK,len=*),parameter :: space = CK_' '
42-
character(kind=CK,len=*),parameter :: start_object = CK_'{'
43-
character(kind=CK,len=*),parameter :: end_object = CK_'}'
44-
character(kind=CK,len=*),parameter :: start_array = CK_'['
45-
character(kind=CK,len=*),parameter :: end_array = CK_']'
46-
character(kind=CK,len=*),parameter :: delimiter = CK_','
47-
character(kind=CK,len=*),parameter :: colon_char = CK_':'
48-
character(kind=CK,len=*),parameter :: start_array_alt = CK_'(' !! for [[json_get_by_path]]
49-
character(kind=CK,len=*),parameter :: end_array_alt = CK_')' !! for [[json_get_by_path]]
50-
character(kind=CK,len=*),parameter :: root = CK_'$' !! for [[json_get_by_path]]
51-
character(kind=CK,len=*),parameter :: this = CK_'@' !! for [[json_get_by_path]]
52-
character(kind=CK,len=*),parameter :: dot = CK_'.' !! for [[json_get_by_path]]
41+
character(kind=CK,len=*),parameter :: space = CK_' ' !! space character
42+
character(kind=CK,len=*),parameter :: start_object = CK_'{' !! start of a JSON object
43+
character(kind=CK,len=*),parameter :: end_object = CK_'}' !! end of a JSON object
44+
character(kind=CK,len=*),parameter :: start_array = CK_'[' !! start of a JSON array
45+
character(kind=CK,len=*),parameter :: end_array = CK_']' !! end of a JSON array
46+
character(kind=CK,len=*),parameter :: delimiter = CK_',' !! delimiter for JSON
47+
character(kind=CK,len=*),parameter :: colon_char = CK_':' !! colon character for JSON
48+
character(kind=CK,len=*),parameter :: start_array_alt = CK_'(' !! alternate start of JSON array for [[json_get_by_path_default]]
49+
character(kind=CK,len=*),parameter :: end_array_alt = CK_')' !! alternate end of JSON array for [[json_get_by_path_default]]
50+
character(kind=CK,len=*),parameter :: root = CK_'$' !! root for [[json_get_by_path_default]]
51+
character(kind=CK,len=*),parameter :: this = CK_'@' !! 'this' for [[json_get_by_path_default]]
52+
character(kind=CK,len=*),parameter :: dot = CK_'.' !! path separator for [[json_get_by_path_default]]
5353
character(kind=CK,len=*),parameter :: tilde = CK_'~' !! RFC 6901 escape character
5454
character(kind=CK,len=*),parameter :: percent = CK_'%' !! Fortran path separator
5555
character(kind=CK,len=*),parameter :: single_quote = CK_"'" !! for JSONPath bracket-notation
56-
character(kind=CK,len=*),parameter :: bspace = achar(8, kind=CK)
57-
character(kind=CK,len=*),parameter :: horizontal_tab = achar(9, kind=CK)
58-
character(kind=CK,len=*),parameter :: newline = achar(10, kind=CK)
59-
character(kind=CK,len=*),parameter :: formfeed = achar(12, kind=CK)
60-
character(kind=CK,len=*),parameter :: carriage_return = achar(13, kind=CK)
61-
character(kind=CK,len=*),parameter :: quotation_mark = achar(34, kind=CK)
62-
character(kind=CK,len=*),parameter :: slash = achar(47, kind=CK)
63-
character(kind=CK,len=*),parameter :: backslash = achar(92, kind=CK)
56+
character(kind=CK,len=*),parameter :: bspace = achar(8, kind=CK) !! JSON special character
57+
character(kind=CK,len=*),parameter :: horizontal_tab = achar(9, kind=CK) !! JSON special character
58+
character(kind=CK,len=*),parameter :: newline = achar(10, kind=CK) !! JSON special character
59+
character(kind=CK,len=*),parameter :: formfeed = achar(12, kind=CK) !! JSON special character
60+
character(kind=CK,len=*),parameter :: carriage_return = achar(13, kind=CK) !! JSON special character
61+
character(kind=CK,len=*),parameter :: quotation_mark = achar(34, kind=CK) !! JSON special character
62+
character(kind=CK,len=*),parameter :: slash = achar(47, kind=CK) !! JSON special character
63+
character(kind=CK,len=*),parameter :: backslash = achar(92, kind=CK) !! JSON special character
6464

6565
character(kind=CDK,len=*),parameter :: default_real_fmt = '(ss,E27.17E4)'
6666
!! default real number format statement (for writing real values to strings and files).
@@ -103,11 +103,11 @@ module json_parameters
103103
!Get the number of possible digits in the exponent when using decimal number system
104104
integer(IK),parameter :: maxexp = maxexponent(1.0_RK)
105105
integer(IK),parameter :: minexp = minexponent(1.0_RK)
106-
integer(IK),parameter :: real_exponent_digits = floor( 1 + log10( &
106+
integer(IK),parameter :: real_exponent_digits = floor( 1_IK + log10( &
107107
real(max(maxexp,abs(maxexp)),&
108108
kind=RK) ) )
109109

110-
integer(IK),parameter :: max_numeric_str_len = real_precision + real_exponent_digits + 6
110+
integer(IK),parameter :: max_numeric_str_len = real_precision + real_exponent_digits + 6_IK
111111
!! 6 = sign + leading 0 + decimal + 'E' + exponent sign + 1 extra
112112
character(kind=CDK,len=*),parameter :: int_fmt = '(ss,I0)' !! minimum width format for integers
113113

‎src/json_string_utilities.F90

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ subroutine string_to_integer(str,ival,status_ok)
116116

117117
implicit none
118118

119-
character(kind=CK,len=*),intent(in) :: str !! the string to conver to an integer
119+
character(kind=CK,len=*),intent(in) :: str !! the string to convert to an integer
120120
integer(IK),intent(out) :: ival !! the integer value
121121
logical(LK),intent(out) :: status_ok !! true if there were no errors
122122

@@ -193,8 +193,8 @@ subroutine string_to_real(str,rval,status_ok)
193193

194194
implicit none
195195

196-
character(kind=CK,len=*),intent(in) :: str
197-
real(RK),intent(out) :: rval
196+
character(kind=CK,len=*),intent(in) :: str !! the string to convert to a real
197+
real(RK),intent(out) :: rval !! `str` converted to a real value
198198
logical(LK),intent(out) :: status_ok !! true if there were no errors
199199

200200
integer(IK) :: ierr !! read iostat error code
@@ -322,7 +322,6 @@ subroutine escape_string(str_in, str_out, escape_solidus)
322322

323323
character(kind=CK,len=*),parameter :: specials = specials_no_slash//slash
324324

325-
326325
!Do a quick scan for the special characters,
327326
! if any are present, then process the string,
328327
! otherwise, return the string as is.

‎src/json_value_module.F90

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7208,8 +7208,8 @@ function string_to_int(json,str) result(ival)
72087208
implicit none
72097209

72107210
class(json_core),intent(inout) :: json
7211-
character(kind=CK,len=*),intent(in) :: str
7212-
integer(IK) :: ival
7211+
character(kind=CK,len=*),intent(in) :: str !! a string
7212+
integer(IK) :: ival !! `str` converted to an integer
72137213

72147214
logical(LK) :: status_ok !! error flag for [[string_to_integer]]
72157215

@@ -7274,7 +7274,7 @@ subroutine json_get_integer(json, me, value)
72747274

72757275
class(json_core),intent(inout) :: json
72767276
type(json_value),pointer,intent(in) :: me
7277-
integer(IK),intent(out) :: value
7277+
integer(IK),intent(out) :: value !! the integer value
72787278

72797279
logical(LK) :: status_ok !! for [[string_to_integer]]
72807280

0 commit comments

Comments
 (0)