Skip to content

Commit a84ebda

Browse files
committed
some cleanup of doc strings and error messages.
1 parent 84983c8 commit a84ebda

File tree

6 files changed

+95
-72
lines changed

6 files changed

+95
-72
lines changed

json-fortran.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Official Releases
5757

5858
The **current stable release** is **{!.VERSION!}** and can be [downloaded
5959
on GitHub](https://github.com/jacobwilliams/json-fortran/releases/latest)
60-
or installed with [Homebrew](http://brew.sh) on Mac OSX. The
60+
or installed with [Homebrew](http://brew.sh) on MacOS. The
6161
documentation for the current version, **{!.VERSION!}**, can be
6262
found [here](http://jacobwilliams.github.io/json-fortran/{!.VERSION!}/index.html)[^1], and a
6363
list of changes from the previous version are
@@ -74,6 +74,7 @@ Miscellaneous
7474

7575
*[API]: Application Programming Interface: a set of routines, protocols, and tools for building software applications
7676
*[JSON]: JavaScript Object Notation: A human friendly syntax for storing and exchanging data
77+
*[variable type]: json_unknown, json_null, json_object, json_array, json_logical, json_integer, json_double, json_string
7778
*[current stable release]: {!.VERSION!}
7879
*[latest stable release]: {!.VERSION!}
7980

src/json_file_module.F90

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -353,7 +353,7 @@ end subroutine json_file_print_error_message
353353
! Initialize the [[json_core(type)]] for this [[json_file]].
354354
! This is just a wrapper for [[json_initialize]].
355355
!
356-
!@note: This does not destroy the data in the file.
356+
!@note This does not destroy the data in the file.
357357
!
358358
!@note [[initialize_json_core]], [[json_initialize]],
359359
! [[initialize_json_core_in_file]], and [[initialize_json_file]]
@@ -401,9 +401,9 @@ end subroutine initialize_json_core_in_file
401401
!>
402402
! Set the [[json_core(type)]] for this [[json_file]].
403403
!
404-
!@note: This does not destroy the data in the file.
404+
!@note This does not destroy the data in the file.
405405
!
406-
!@note: This one is used if you want to initialize the file with
406+
!@note This one is used if you want to initialize the file with
407407
! an already-existing [[json_core(type)]] (presumably, this was already
408408
! initialized by a call to [[initialize_json_core]] or similar).
409409

src/json_module.F90

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,12 @@
2222
#pragma pop_macro("USE_UCS4")
2323
#endif
2424
!
25-
!## License
25+
!### License
2626
! * JSON-Fortran is released under a BSD-style license.
2727
! See the [LICENSE](https://github.com/jacobwilliams/json-fortran/blob/master/LICENSE)
2828
! file for details.
2929
!
30-
!## History
30+
!### History
3131
! * Joseph A. Levin : March 2012 : Original [FSON](https://github.com/josephalevin/fson)
3232
! code [retrieved on 12/2/2013].
3333
! * Jacob Williams : 2/8/2014 : Extensive modifications to the original FSON code.
@@ -39,7 +39,7 @@
3939
! (e.g., allocatable strings, newunit, generic, class, and abstract interface).
4040
! * Development continues at: [Github](http://github.com/jacobwilliams/json-fortran)
4141
!
42-
!## See also
42+
!### See also
4343
! * [json-fortran development site](http://github.com/jacobwilliams/json-fortran)
4444
! * [json-fortran online documentation](http://jacobwilliams.github.io/json-fortran)
4545
! * [JSON website](http://www.json.org/)

src/json_parameters.F90

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
! Other parameters used by JSON-Fortran.
66
! This is a low-level module not meant to be used by a JSON-Fortran user.
77
!
8-
!## License
8+
!### License
99
! * JSON-Fortran is released under a BSD-style license.
1010
! See the [LICENSE](https://github.com/jacobwilliams/json-fortran/blob/master/LICENSE)
1111
! file for details.

src/json_string_utilities.F90

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
!
55
! JSON-Fortran support module for string manipulation.
66
!
7-
!## License
7+
!### License
88
! * JSON-Fortran is released under a BSD-style license.
99
! See the [LICENSE](https://github.com/jacobwilliams/json-fortran/blob/master/LICENSE)
1010
! file for details.

0 commit comments

Comments
 (0)