Skip to content

Commit 7c629b6

Browse files
committed
more minor documentation updates.
1 parent c65ec9d commit 7c629b6

File tree

2 files changed

+13
-20
lines changed

2 files changed

+13
-20
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Status
1515
Brief description
1616
---------------
1717

18-
An easy-to-use API for reading and writing JSON files, written in
18+
A user-friendly and object-oriented API for reading and writing JSON files, written in
1919
modern Fortran. The source code is a single Fortran module file ([json_module.f90](https://github.com/jacobwilliams/json-fortran/blob/master/src/json_module.f90)).
2020

2121
Download [![GitHub release](https://img.shields.io/github/release/jacobwilliams/json-fortran.svg?style=plastic)](https://github.com/jacobwilliams/json-fortran/releases)
@@ -145,7 +145,7 @@ Building a JSON file from scratch
145145
---------------
146146

147147
Constructing a JSON file element by element is slightly more complicated and involves the use
148-
of `json_value` pointers. For more examples see unit tests 2,4 and 7 in `src/tests/`.
148+
of `json_value` pointers. For more examples see unit tests 2, 4 and 7 in `src/tests/`.
149149

150150
```fortran
151151
program example2

src/json_module.f90

Lines changed: 11 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -9,24 +9,6 @@ module json_module
99
! DESCRIPTION
1010
! JSON-FORTRAN: A Fortran 2008 JSON (JavaScript Object Notation) API.
1111
!
12-
! NOTES
13-
!
14-
! * Based on fson by Joseph A. Levin (see License below).
15-
! The original F95 code was split into four files:
16-
! fson_path_m.f95, fson_string_m.f95, fson_value_m.f95, and fson.f95.
17-
! The code has been extensively modified and combined into this
18-
! one module (json_module.f90).
19-
! Some Fortran 2003/2008 features are now used
20-
! (e.g., allocatable strings, newunit, generic, class, abstract interface)
21-
! * The headers in this file follow the ROBODoc conventions. The API
22-
! documentation can be generated by, for example:
23-
!
24-
! robodoc --rc ./robodoc.rc --src ./ --doc ./doc
25-
!
26-
! HISTORY
27-
! * Joseph A. Levin : March 2012
28-
! * Jacob Williams : 2/8/2013 : Extensive modifications to the original code.
29-
!
3012
! SEE ALSO
3113
! * http://github.com/jacobwilliams/json-fortran [json-fortran development site]
3214
! * http://jacobwilliams.github.io/json-fortran [json-fortran online documentation]
@@ -89,6 +71,17 @@ module json_module
8971
! OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
9072
! DEALINGS IN THE SOFTWARE.
9173
!
74+
! HISTORY
75+
! * Joseph A. Levin : March 2012 : Original FSON code [retrieved on 12/2/2013].
76+
! * Jacob Williams : 2/8/2014 : Extensive modifications to the original FSON code.
77+
! The original F95 code was split into four files:
78+
! fson_path_m.f95, fson_string_m.f95, fson_value_m.f95, and fson.f95.
79+
! The new code has been extensively updated, refactored and combined into this
80+
! one module (json_module.f90).
81+
! Various Fortran 2003/2008 features are now used
82+
! (e.g., allocatable strings, newunit, generic, class, and abstract interface).
83+
! * Development continues at: http://github.com/jacobwilliams/json-fortran
84+
!
9285
!*****************************************************************************************
9386
use,intrinsic :: iso_fortran_env
9487

0 commit comments

Comments
 (0)