Correct comments to be compatible with doxygen and add graphs generated by Graphviz

Author: AhmedMzid

CMakeLists.txt

@@ -3,9 +3,10 @@ cmake_minimum_required(VERSION 3.7)
 # set name and version of the project 
 project(open_simulation_interface)
 set(VERSION_MAJOR 2)
-set(VERSION_MINOR 1)
+set(VERSION_MINOR 2)
 set(VERSION_PATCH 1)
 
+
 find_package(Protobuf 2.6.1 REQUIRED)
 
 set(OSI_PROTO_FILES
@@ -83,7 +84,7 @@ else()
 
 	else()
 
-		set(doxyfile_in ${CMAKE_CURRENT_SOURCE_DIR}/doxygen-config.cmake.in)
+		set(doxyfile_in ${CMAKE_CURRENT_SOURCE_DIR}/doxygen_config.cmake.in)
 		set(doxyfile ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
 
 		configure_file(${doxyfile_in} ${doxyfile} @ONLY)

README.md

@@ -81,10 +81,11 @@ Documentation
 -------------
 
 In order to generate the doxygen documentation for OSI, please follow the following steps: 
-1. Install Doxygen and set an environmental variable 'Doxygen' with the path to the binary file.
-2. Download and unzip the [zip file containing the filter proto2cpp.py](https://sourceforge.net/projects/proto2cpp/files/latest/download ).
-3. From the cmd navigate to the build directory and run: 
+1. Install [Doxygen](http://www.stack.nl/~dimitri/doxygen/download.html) and set an environmental variable 'doxygen' with the path to the binary file.
+2. Download and unzip the [zip file containing the filter proto2cpp.py](https://sourceforge.net/p/proto2cpp/wiki/Home/ ).
+3. Install [graphviz-2.38](http://www.graphviz.org/Download_windows.php ) and set an environmental variable 'dot' with the path to the binary file.
+4. From the cmd navigate to the build directory and run: 
 ```cmd
 cmake -DFILTER_PROTO2CPP_PY_PATH=<path-to-proto2cpp.py> <path-to-CMakeLists.txt>
 ```
-4. The build process will then generate the doxygen documentation under the directory doc.
+5. The build process will then generate the doxygen documentation under the directory doc.

doxygen-config.cmake.in renamed to doxygen_config.cmake.in

@@ -4,11 +4,18 @@ PROJECT_NUMBER         = @VERSION_MAJOR@.@VERSION_MINOR@.@VERSION_PATCH@
 
 #Set input and output directories 
 INPUT                  = "@CMAKE_CURRENT_SOURCE_DIR@"
+INPUT       	      += "@CMAKE_CURRENT_SOURCE_DIR@/README.md"
+
+USE_MDFILE_AS_MAINPAGE = "@CMAKE_CURRENT_SOURCE_DIR@/README.md"
+
 OUTPUT_DIRECTORY       = "@CMAKE_CURRENT_SOURCE_DIR@/doc"
+IMAGE_PATH	       = "@CMAKE_CURRENT_SOURCE_DIR@/doc/images"
 
 # There is no standard configuration for .proto files documentation.
 # A Doxygen filter for .proto files has to be added under the directory doc/.
-JAVADOC_AUTOBRIEF      = YES
+JAVADOC_AUTOBRIEF      = NO
 EXTENSION_MAPPING      = proto=C
 FILE_PATTERNS          = *.proto
 INPUT_FILTER           = "python @FILTER_PROTO2CPP_PY_PATH@/proto2cpp.py"
+HAVE_DOT	       = YES
+