Skip to content

Commit 1d87463

Browse files
committed
documentation updates.
1 parent 77eb985 commit 1d87463

File tree

7 files changed

+117
-119
lines changed

7 files changed

+117
-119
lines changed

src/json_file_module.F90

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,11 @@
33
! license: BSD
44
!
55
! Higher-level [[json_file]] interface for the [[json_value]] type.
6+
!
7+
!## License
8+
! * JSON-Fortran is released under a BSD-style license.
9+
! See the [LICENSE](https://github.com/jacobwilliams/json-fortran/blob/master/LICENSE)
10+
! file for details.
611

712
module json_file_module
813

src/json_kinds.F90

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@
44
!
55
! JSON-Fortran kind definitions.
66
!
7+
!## License
8+
! * JSON-Fortran is released under a BSD-style license.
9+
! See the [LICENSE](https://github.com/jacobwilliams/json-fortran/blob/master/LICENSE)
10+
! file for details.
11+
!
712
!@note ```-DUSE_UCS4``` is an optional preprocessor flag.
813
! When present, Unicode support is enabled. Note that this
914
! is currently only supported with the gfortran compiler.

src/json_macros.inc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
!*****************************************************************************************
22
!>
33
! JSON-Fortran preprocessor macros.
4+
!
5+
!## License
6+
! * JSON-Fortran is released under a BSD-style license.
7+
! See the [LICENSE](https://github.com/jacobwilliams/json-fortran/blob/master/LICENSE)
8+
! file for details.
49

510
!*********************************************************
611
! File encoding preprocessor macro.

src/json_module.F90

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,33 @@
22
!> author: Jacob Williams
33
! license: BSD
44
!
5-
!# JSON-Fortran:
65
! A Fortran 2008 JSON (JavaScript Object Notation) API.
6+
!
77
! This module provides access to the [[json_value_module]] and [[json_file_module]],
88
! Either one can be used separately, or both can be used by using this module.
99
!
10+
!## License
11+
! * JSON-Fortran is released under a BSD-style license.
12+
! See the [LICENSE](https://github.com/jacobwilliams/json-fortran/blob/master/LICENSE)
13+
! file for details.
14+
!
15+
!## History
16+
! * Joseph A. Levin : March 2012 : Original FSON code [retrieved on 12/2/2013].
17+
! * Jacob Williams : 2/8/2014 : Extensive modifications to the original FSON code.
18+
! The original F95 code was split into four files:
19+
! fson_path_m.f95, fson_string_m.f95, fson_value_m.f95, and fson.f95.
20+
! The new code has been extensively updated, refactored and combined into this
21+
! one module (json_module.f90).
22+
! Various Fortran 2003/2008 features are now used
23+
! (e.g., allocatable strings, newunit, generic, class, and abstract interface).
24+
! * Development continues at: [Github](http://github.com/jacobwilliams/json-fortran)
25+
!
26+
!## See also
27+
! * [json-fortran development site](http://github.com/jacobwilliams/json-fortran)
28+
! * [json-fortran online documentation](http://jacobwilliams.github.io/json-fortran)
29+
! * [JSON website](http://www.json.org/)
30+
! * [JSON validator](http://jsonlint.com/)
31+
!
1032
!@note Originally JSON-Fortran was entirely contained within this module.
1133

1234
module json_module

src/json_parameters.F90

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@
44
!
55
! Other parameters used by JSON-Fortran.
66
! This is a low-level module not meant to be used by a JSON-Fortran user.
7+
!
8+
!## License
9+
! * JSON-Fortran is released under a BSD-style license.
10+
! See the [LICENSE](https://github.com/jacobwilliams/json-fortran/blob/master/LICENSE)
11+
! file for details.
712

813
module json_parameters
914

src/json_string_utilities.F90

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,11 @@
33
! license: BSD
44
!
55
! JSON-Fortran support module for string manipulation.
6+
!
7+
!## License
8+
! * JSON-Fortran is released under a BSD-style license.
9+
! See the [LICENSE](https://github.com/jacobwilliams/json-fortran/blob/master/LICENSE)
10+
! file for details.
611

712
module json_string_utilities
813

0 commit comments

Comments
 (0)