documentation formatting updates for unit tests.

Author: jacobwilliams

robodoc.rc

@@ -32,6 +32,7 @@ items:
     RESULT
     SEE ALSO
     USAGE
+    USES
     WARNINGS
 source line comments:
     !

src/tests/jf_test_1.f90

@@ -1,8 +1,8 @@
 !*******************************************************************************************************
-!****f* JSON/test_1
+!****u* JSON/jf_test_1
 !
 !  NAME
-!    json_test
+!    jf_test_1
 !
 !  DESCRIPTION
 !    First unit test
@@ -12,11 +12,11 @@
 !    iso_fortran_env (intrinsic)
 !
 !  HISTORY
-!    Izaak Beekman  : 2/18/2015 : Created
+!    Izaak Beekman : 2/18/2015 : Created (refactoried original json_example.f90 file)
 !
-!  COPYRIGHT
+!  LICENSE
 !
-!    JSON-FORTRAN: A Fortran 2003/2008 JSON API
+!    JSON-FORTRAN: A Fortran 2008 JSON API
 !    https://github.com/jacobwilliams/json-fortran
 !
 !    Copyright (c) 2014, Jacob Williams
@@ -47,22 +47,23 @@
 !    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 !
 !  SOURCE
+
 module jf_test_1_mod
+
     use json_module
     use, intrinsic :: iso_fortran_env , only: error_unit, output_unit, wp => real64
+
     implicit none
-    character(len=*),parameter :: dir = '../files/'               !working directory
 
+    character(len=*),parameter :: dir = '../files/'    !working directory
     character(len=*),parameter :: filename1 = 'test1.json'
 
 contains
-!**************************************************************
-    subroutine test_1(error_cnt)
-!**************************************************************
-!
-!    Read a sample JSON file and retrieve some data from it
-!
-!**************************************************************
+
+    subroutine test_1(error_cnt) 
+
+!   Read a sample JSON file and retrieve some data from it
+
     implicit none
 
     integer,intent(out) :: error_cnt
@@ -278,12 +279,9 @@ subroutine test_1(error_cnt)
         error_cnt = error_cnt + 1
     end if
 
-!**************************************************************
     end subroutine test_1
-!**************************************************************
 
 end module jf_test_1_mod
-!*******************************************************************************************************
 
 program jf_test_1
     use jf_test_1_mod , only: test_1
@@ -293,3 +291,5 @@ program jf_test_1
     call test_1(n_errors)
     if (n_errors /= 0) stop 1
 end program jf_test_1
+
+!*******************************************************************************************************

src/tests/jf_test_2.f90

@@ -1,8 +1,8 @@
 !*******************************************************************************************************
-!****f* JSON/test_2
+!****u* JSON/jf_test_2
 !
 !  NAME
-!    json_test
+!    jf_test_2
 !
 !  DESCRIPTION
 !    Second unit test
@@ -12,11 +12,11 @@
 !    iso_fortran_env (intrinsic)
 !
 !  HISTORY
-!    Izaak Beekman  : 2/18/2015 : Created
+!    Izaak Beekman : 2/18/2015 : Created (refactoried original json_example.f90 file)
 !
-!  COPYRIGHT
+!  LICENSE
 !
-!    JSON-FORTRAN: A Fortran 2003/2008 JSON API
+!    JSON-FORTRAN: A Fortran 2008 JSON API
 !    https://github.com/jacobwilliams/json-fortran
 !
 !    Copyright (c) 2014, Jacob Williams
@@ -47,22 +47,23 @@
 !    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 !
 !  SOURCE
+
 module jf_test_2_mod
+
     use json_module
     use, intrinsic :: iso_fortran_env , only: error_unit, output_unit, wp => real64
+
     implicit none
-    character(len=*),parameter :: dir = '../files/'               !working directory
 
+    character(len=*),parameter :: dir = '../files/'    !working directory
     character(len=*),parameter :: filename2 = 'test2.json'
 
 contains
-!**************************************************************
-    subroutine test_2(error_cnt)
-!**************************************************************
-!
-!    Populate a JSON structure and write it to a file.
-!
-!**************************************************************
+
+    subroutine test_2(error_cnt)    
+
+!   Populate a JSON structure and write it to a file.
+
     implicit none
 
     integer,intent(out) :: error_cnt
@@ -196,15 +197,10 @@ subroutine test_2(error_cnt)
 
     write(error_unit,'(A)') ''
 
-!**************************************************************
     end subroutine test_2
-!**************************************************************
 
-!**************************************************************
     subroutine add_variables_to_input(me, variable, units, frame, center, rdata, error_cnt)
-!**************************************************************
-!    Used by test_2.
-!**************************************************************
+    !Used by test_2.
 
     implicit none
 
@@ -264,12 +260,9 @@ subroutine add_variables_to_input(me, variable, units, frame, center, rdata, err
     !cleanup:
     nullify(var)
 
-!**************************************************************
     end subroutine add_variables_to_input
-!**************************************************************
 
 end module jf_test_2_mod
-!*******************************************************************************************************
 
 program jf_test_2
     use jf_test_2_mod , only: test_2
@@ -279,3 +272,5 @@ program jf_test_2
     call test_2(n_errors)
     if (n_errors /= 0) stop 1
 end program jf_test_2
+
+!*******************************************************************************************************

src/tests/jf_test_3.f90

@@ -1,8 +1,8 @@
 !*******************************************************************************************************
-!****f* JSON/test_3
+!****u* JSON/jf_test_3
 !
 !  NAME
-!    json_test
+!    jf_test_3
 !
 !  DESCRIPTION
 !    Third unit test
@@ -12,11 +12,11 @@
 !    iso_fortran_env (intrinsic)
 !
 !  HISTORY
-!    Izaak Beekman  : 2/18/2015 : Created
+!    Izaak Beekman : 2/18/2015 : Created (refactoried original json_example.f90 file)
 !
-!  COPYRIGHT
+!  LICENSE
 !
-!    JSON-FORTRAN: A Fortran 2003/2008 JSON API
+!    JSON-FORTRAN: A Fortran 2008 JSON API
 !    https://github.com/jacobwilliams/json-fortran
 !
 !    Copyright (c) 2014, Jacob Williams
@@ -47,24 +47,23 @@
 !    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 !
 !  SOURCE
+
 module jf_test_3_mod
+
     use json_module
     use, intrinsic :: iso_fortran_env , only: error_unit, output_unit, wp => real64
+
     implicit none
-    character(len=*),parameter :: dir = '../files/'               !working directory
 
+    character(len=*),parameter :: dir = '../files/'               !working directory
     character(len=*),parameter :: filename2 = 'test2.json'
 
 contains
 
-!**************************************************************
     subroutine test_3(error_cnt)
-!**************************************************************
-!
-!    Read the file generated in test_2, and extract
-!        some data from it.
-!
-!**************************************************************
+
+!   Read the file generated in jf_test_2, and extract some data from it.
+
     implicit none
 
     integer,intent(out) :: error_cnt
@@ -163,12 +162,9 @@ subroutine test_3(error_cnt)
         error_cnt = error_cnt + 1
     end if
 
-!**************************************************************
     end subroutine test_3
-!**************************************************************
 
 end module jf_test_3_mod
-!*******************************************************************************************************
 
 program jf_test_3
     use jf_test_3_mod , only: test_3
@@ -178,3 +174,5 @@ program jf_test_3
     call test_3(n_errors)
     if (n_errors /= 0) stop 1
 end program jf_test_3
+
+!*******************************************************************************************************

src/tests/jf_test_4.f90

@@ -1,8 +1,8 @@
 !*******************************************************************************************************
-!****f* JSON/test_4
+!****u* JSON/jf_test_4
 !
 !  NAME
-!    json_test
+!    jf_test_4
 !
 !  DESCRIPTION
 !    Fourth unit test
@@ -12,11 +12,11 @@
 !    iso_fortran_env (intrinsic)
 !
 !  HISTORY
-!    Izaak Beekman  : 2/18/2015 : Created
+!    Izaak Beekman : 2/18/2015 : Created (refactoried original json_example.f90 file)
 !
-!  COPYRIGHT
+!  LICENSE
 !
-!    JSON-FORTRAN: A Fortran 2003/2008 JSON API
+!    JSON-FORTRAN: A Fortran 2008 JSON API
 !    https://github.com/jacobwilliams/json-fortran
 !
 !    Copyright (c) 2014, Jacob Williams
@@ -47,27 +47,28 @@
 !    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 !
 !  SOURCE
+
 module jf_test_4_mod
+
     use json_module
     use, intrinsic :: iso_fortran_env , only: error_unit, output_unit, wp => real64
+
     implicit none
-    character(len=*),parameter :: dir = '../files/'               !working directory
 
+    character(len=*),parameter :: dir = '../files/'               !working directory
     character(len=*),parameter :: filename4 = 'test4.json'
 
 contains
 
-!**************************************************************
+
     subroutine test_4(error_cnt)
-!**************************************************************
-!
+
 !    Populate a JSON structure, write it to a file,
 !        then read it.
 !
 !    Also tests the json_value_to_string routine to write
 !     the file to a character string.
-!
-!**************************************************************
+
     implicit none
 
     integer,intent(out) :: error_cnt
@@ -162,7 +163,6 @@ subroutine test_4(error_cnt)
         error_cnt = error_cnt + 1
     end if
 
-
     write(error_unit,'(A)') ''
     write(error_unit,'(A)') 'cleanup'
     call json%destroy()
@@ -171,12 +171,9 @@ subroutine test_4(error_cnt)
         error_cnt = error_cnt + 1
     end if
 
-!**************************************************************
     end subroutine test_4
-!**************************************************************
 
 end module jf_test_4_mod
-!*******************************************************************************************************
 
 program jf_test_4
     use jf_test_4_mod , only: test_4
@@ -186,3 +183,5 @@ program jf_test_4
     call test_4(n_errors)
     if (n_errors /= 0) stop 1
 end program jf_test_4
+
+!*******************************************************************************************************