convert unit tests to FORD documentation syntax.

Author: jacobwilliams

src/tests/jf_test_1.f90

@@ -1,50 +1,9 @@
-!*******************************************************************************************************
-!****u* JSON/jf_test_1
+!*****************************************************************************************
+!>
+! Module for the first unit test.
 !
-!  NAME
-!    jf_test_1
-!
-!  DESCRIPTION
-!    First unit test
-!
-!  USES
-!    json_module
-!    iso_fortran_env (intrinsic)
-!
-!  HISTORY
-!    Izaak Beekman : 2/18/2015 : Created (refactoried original json_example.f90 file)
-!
-!  LICENSE
-!
-!    JSON-Fortran: A Fortran 2008 JSON API
-!
-!    https://github.com/jacobwilliams/json-fortran
-!
-!    Copyright (c) 2014, Jacob Williams
-!
-!    All rights reserved.
-!
-!    Redistribution and use in source and binary forms, with or without modification,
-!    are permitted provided that the following conditions are met:
-!    * Redistributions of source code must retain the above copyright notice, this
-!      list of conditions and the following disclaimer.
-!    * Redistributions in binary form must reproduce the above copyright notice, this
-!      list of conditions and the following disclaimer in the documentation and/or
-!      other materials provided with the distribution.
-!    * The names of its contributors may not be used to endorse or promote products
-!      derived from this software without specific prior written permission.
-!    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-!    ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-!    WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-!    DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
-!    ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
-!    (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
-!    LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
-!    ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-!    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-!    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-!
-!  SOURCE
+!# HISTORY
+!  * Izaak Beekman : 2/18/2015 : Created (refactoried original json_example.f90 file)
 
 module jf_test_1_mod
 
@@ -53,14 +12,14 @@ module jf_test_1_mod
 
     implicit none
 
-    character(len=*),parameter :: dir = '../files/inputs/'    !working directory
+    character(len=*),parameter :: dir = '../files/inputs/'    !! 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
+    !! Read a sample JSON file and retrieve some data from it
 
     implicit none
 
@@ -284,14 +243,19 @@ subroutine test_1(error_cnt)
     end subroutine test_1
 
 end module jf_test_1_mod
+!*****************************************************************************************
 
+!*****************************************************************************************
 program jf_test_1
+
+    !! First unit test.
+    
     use jf_test_1_mod , only: test_1
     implicit none
     integer :: n_errors
     n_errors = 0
     call test_1(n_errors)
     if (n_errors /= 0) stop 1
+    
 end program jf_test_1
-
-!*******************************************************************************************************
+!*****************************************************************************************

src/tests/jf_test_10.f90

@@ -1,46 +1,8 @@
-!*******************************************************************************************************
-!****u* JSON/jf_test_10
+!*****************************************************************************************
+!> author: Jacob Williams
+!  date: 3/10/2015
 !
-!  NAME
-!    jf_test_10
-!
-!  DESCRIPTION
-!    Tenth unit test.
-!
-!  AUTHOR
-!    Jacob Williams : 3/10/3015
-!
-!  LICENSE
-!
-!    JSON-Fortran: A Fortran 2008 JSON API
-!
-!    https://github.com/jacobwilliams/json-fortran
-!
-!    Copyright (c) 2014, Jacob Williams
-!
-!    All rights reserved.
-!
-!    Redistribution and use in source and binary forms, with or without modification,
-!    are permitted provided that the following conditions are met:
-!    * Redistributions of source code must retain the above copyright notice, this
-!      list of conditions and the following disclaimer.
-!    * Redistributions in binary form must reproduce the above copyright notice, this
-!      list of conditions and the following disclaimer in the documentation and/or
-!      other materials provided with the distribution.
-!    * The names of its contributors may not be used to endorse or promote products
-!      derived from this software without specific prior written permission.
-!    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-!    ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-!    WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-!    DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
-!    ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
-!    (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
-!    LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
-!    ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-!    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-!    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-!
-!  SOURCE
+! Module for the tenth unit test.
 
 module jf_test_10_mod
 
@@ -56,7 +18,7 @@ module jf_test_10_mod
 
     subroutine test_10(error_cnt)
 
-!   Test some of the lesser-used features of the library
+    !! Test some of the lesser-used features of the library
 
     implicit none
 
@@ -353,14 +315,18 @@ subroutine test_10(error_cnt)
     end subroutine test_10
 
 end module jf_test_10_mod
+!*****************************************************************************************
 
+!*****************************************************************************************
 program jf_test_10
+
+    !! Tenth unit test.
+    
     use jf_test_10_mod , only: test_10
     implicit none
     integer :: n_errors
     n_errors = 0
     call test_10(n_errors)
     if (n_errors /= 0) stop 1
 end program jf_test_10
-
-!*******************************************************************************************************
+!*****************************************************************************************

src/tests/jf_test_11.F90

@@ -1,50 +1,8 @@
-!*******************************************************************************************************
-!****u* JSON/jf_test_11
+!*****************************************************************************************
+!> author: Izaak Beekman
+!  date: 3/13/2015
 !
-!  NAME
-!    jf_test_11
-!
-!  DESCRIPTION
-!    11th unit test to test unicode support if enabled
-!
-!  USES
-!    json_module
-!    iso_fortran_env (intrinsic)
-!
-!  HISTORY
-!    Izaak Beekman : created : 3/13/2015
-!
-!  LICENSE
-!
-!    JSON-Fortran: A Fortran 2008 JSON API
-!
-!    https://github.com/jacobwilliams/json-fortran
-!
-!    Copyright (c) 2014, Jacob Williams
-!
-!    All rights reserved.
-!
-!    Redistribution and use in source and binary forms, with or without modification,
-!    are permitted provided that the following conditions are met:
-!    * Redistributions of source code must retain the above copyright notice, this
-!      list of conditions and the following disclaimer.
-!    * Redistributions in binary form must reproduce the above copyright notice, this
-!      list of conditions and the following disclaimer in the documentation and/or
-!      other materials provided with the distribution.
-!    * The names of its contributors may not be used to endorse or promote products
-!      derived from this software without specific prior written permission.
-!    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-!    ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-!    WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-!    DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
-!    ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
-!    (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
-!    LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
-!    ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-!    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-!    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-!
-!  SOURCE
+! Module for the 11th unit test to test unicode support if enabled.
 
 module jf_test_11_mod
 
@@ -53,7 +11,7 @@ module jf_test_11_mod
 
     implicit none
 
-    character(len=*),parameter :: dir = '../files/inputs/'               !working directory
+    character(len=*),parameter :: dir = '../files/inputs/'  !! working directory
 # ifdef USE_UCS4
     character(len=*),parameter :: unicode_file = 'hello-world-ucs4.json'
 #endif
@@ -63,7 +21,7 @@ module jf_test_11_mod
 
     subroutine test_11(error_cnt)
 
-!   Read the file generated in jf_test_2, and extract some data from it.
+    !! Read the file and extract some data from it.
 
     implicit none
 
@@ -319,14 +277,18 @@ subroutine test_11(error_cnt)
     end subroutine test_11
 
 end module jf_test_11_mod
+!*****************************************************************************************
 
+!*****************************************************************************************
 program jf_test_11
+
+    !! 11th unit test.
+    
     use jf_test_11_mod , only: test_11
     implicit none
     integer :: n_errors
     n_errors = 0
     call test_11(n_errors)
     if (n_errors /= 0) stop 1
 end program jf_test_11
-
-!*******************************************************************************************************
+!*****************************************************************************************

src/tests/jf_test_12.f90

@@ -1,12 +1,18 @@
+!*****************************************************************************************
+!> author: Izaak Beekman
+!  date: 07/27/2015
+!
+! Module for the 12th unit test.
+
 module jf_test_12_mod
 
     use json_module
     use, intrinsic :: iso_fortran_env , only: error_unit, output_unit, wp => real64
 
     implicit none
 
-    character(len=*),parameter :: dir = '../files/' !! Path to write JSON file to
-    character(len=*),parameter :: file = 'test12.json'       !! Filename to write
+    character(len=*),parameter :: dir = '../files/'         !! Path to write JSON file to
+    character(len=*),parameter :: file = 'test12.json'      !! Filename to write
     real(wp), parameter        :: TOL = 100*epsilon(1.0_wp) !! Tolerance for real comparisons
 
 contains
@@ -162,6 +168,7 @@ subroutine test_12(error_cnt)
     close(lun)
 
     contains
+    
       subroutine check_errors(assertion)
         logical, optional, intent(in) :: assertion
         if (json_failed()) then
@@ -189,13 +196,19 @@ subroutine get_3D_from_array(element, i, count)
 
     end subroutine
 
-end module
+end module jf_test_12_mod
+!*****************************************************************************************
 
+!*****************************************************************************************
 program jf_test_12
+
+    !! 12th unit test.
+    
     use jf_test_12_mod, only: test_12
     implicit none
     integer :: n_errors
     n_errors = 0
     call test_12(n_errors)
     if ( n_errors /= 0) stop 1
-end program
+end program jf_test_12
+!*****************************************************************************************