Skip to content

Commit 5ad9381

Browse files
committed
minor documentation cleanups.
1 parent 409ccbe commit 5ad9381

File tree

2 files changed

+16
-20
lines changed

2 files changed

+16
-20
lines changed

src/json_module.F90

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -281,7 +281,7 @@ module json_module
281281
! program test
282282
! use json_module
283283
! implicit none
284-
! type(json_value),pointer :: p
284+
! type(json_value),pointer :: p
285285
! call json_initialize() !initialize the module
286286
! call json_create_object(p,'') !create the root
287287
! call json_add(p,'year',1805) !add some data
@@ -440,16 +440,16 @@ module json_module
440440
! Structure constructor to initialize a [[json_file(type)]] object
441441
! with an existing [[json_value]] object
442442
!
443-
! # Example
443+
!# Example
444444
!
445-
! ```fortran
445+
!```fortran
446446
! ...
447447
! type(json_file) :: my_file
448448
! type(json_value) :: json_object
449449
! ...
450450
! ! Construct a json_object
451451
! my_file = json_file(json_object)
452-
452+
!```
453453
interface json_file
454454
module procedure initialize_json_file
455455
end interface
@@ -924,8 +924,11 @@ end subroutine array_callback_func
924924
! Cast a [[json_value]] object as a [[json_file(type)]] object
925925

926926
function initialize_json_file(p) result(file_object)
927-
type(json_value), pointer, optional, intent(in) :: p
928-
!! `json_value` object to cast as a `json_file` object
927+
928+
implicit none
929+
930+
type(json_value), pointer, optional, intent(in) :: p !! `json_value` object to cast
931+
!! as a `json_file` object
929932
type(json_file) :: file_object
930933

931934
if (present(p)) file_object%p => p
@@ -936,7 +939,7 @@ end function initialize_json_file
936939
!*****************************************************************************************
937940
!> author: Jacob Williams
938941
!
939-
! Destroy the data within a [[json_value]], and rest type to json_unknown.
942+
! Destroy the data within a [[json_value]], and rest type to `json_unknown`.
940943

941944
subroutine destroy_json_data(d)
942945

@@ -1284,6 +1287,8 @@ end subroutine json_file_get_object
12841287
! date: 7/23/2015
12851288
!
12861289
! Get a [[json_value]] pointer to the JSON file root.
1290+
!
1291+
!@note This is equivalent to calling ```[[json_file]]%get('$',p)```
12871292

12881293
subroutine json_file_get_root(me,p)
12891294

src/tests/introspection/test_iso_10646_support.f90

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,9 @@
11
!*******************************************************************************************************
2-
!****u* JSON/test_iso_10646_support
2+
!> author: Izaak Beekman
33
!
4-
! NAME
5-
! test_iso_10646_support
6-
!
7-
! DESCRIPTION
8-
! This program is run when configuring the json-fortran build,
9-
! to determine whether or not ISO 10646/UCS4 characters are
10-
! supported by the compiler.
11-
!
12-
! AUTHOR
13-
! Izaak Beekman
14-
!
15-
! SOURCE
4+
! This program is run when configuring the json-fortran build,
5+
! to determine whether or not ISO 10646/UCS4 characters are
6+
! supported by the compiler.
167

178
program test_iso_10646_support
189

0 commit comments

Comments
 (0)