Update ford documentation project file

 - new meta data
 - added TOC
 - preprocessor macro workaround in json_module.F90 so that USE_UCS4
   macro is not expanded in the documentation when unicode is enabled

Author: zbeekman

CMakeLists.txt

@@ -145,6 +145,7 @@ set ( SKIP_DOC_GEN FALSE CACHE BOOL
 if ( NOT SKIP_DOC_GEN )
   find_program ( FORD ford )
   if ( FORD ) # Found
+    file ( COPY "${CMAKE_SOURCE_DIR}/media" DESTINATION "${CMAKE_BINARY_DIR}/" )
     set ( DOC_DIR "${CMAKE_BINARY_DIR}/doc" )
     set ( FORD_PROJECT_FILE "${CMAKE_SOURCE_DIR}/json-fortran.md" )
     # Dynamically generate the FORD outputs list

json-fortran.md

@@ -1,20 +1,36 @@
 project: json-fortran
+favicon: ./media/json-fortran-32x32.png
 project_dir: ./src
+macro: USE_UCS4
 output_dir: ./doc
+media_dir: ./media
 project_github: https://github.com/jacobwilliams/json-fortran
 summary: JSON-FORTRAN -- A Fortran 2008 JSON API
 author: Jacob Williams
 github: https://github.com/jacobwilliams
+website: http://degenerateconic.com
+twitter: https://twitter.com/degenerateconic
 predocmark_alt: >
 predocmark: <
 docmark_alt:
 docmark: !
 exclude_dir: tests
 exclude_dir: introspection
 display: public
-display: protected
-display: private
+         protected
+         private
 source: true
+md_extensions: markdown.extensions.toc(anchorlink=True)
+               markdown.extensions.smarty(smart_quotes=False)
+
+<!-- Uncommenting these should work, but this actually causes issues
+
+*[API]: Application Programmable Interface
+*[JSON]: JavaScript Object Notation
+
+-->
+
+[TOC]
 
 # Brief description
 

src/json_module.F90

@@ -6,12 +6,15 @@
 !
 !  This module provides an interface for reading and writing JSON files.
 !
-!@note ```USE_UCS4``` is an optional preprocessor flag.
+!@note ```-DUSE_UCS4``` is an optional preprocessor flag.
 !      When present, Unicode support is enabled. Note that this
 !      is currently only supported with the gfortran compiler.
 !      Example: ```gfortran -DUSE_UCS4 ... ```
 #ifdef USE_UCS4
+#  pragma push_macro("USE_UCS4")
+#  undef USE_UCS4
 !      The documentation given here assumes ```USE_UCS4``` **is** defined.
+#  pragma pop_macro("USE_UCS4")
 #else
 !      The documentation given here assumes ```USE_UCS4``` **is not** defined.
 #endif