delete proto2cpp and get the filter proto2cpp.py from a local directory

Author: AhmedMzid

CMakeLists.txt

@@ -67,15 +67,31 @@ target_link_libraries(${PROJECT_NAME} PUBLIC ${PROTOBUF_LIBRARY})
 
 
 # add a target to generate API documentation with Doxygen
+# Dependencies: Doxygen and proto2cpp.py
 FIND_PACKAGE(Doxygen)
+set(FILTER_PROTO2CPP_PY_PATH CACHE PATH "directory to the filter proto2cpp.py")
 
-IF (DOXYGEN_FOUND)
-	set(doxyfile_in ${CMAKE_CURRENT_SOURCE_DIR}/doxygen-config.cmake.in)
-    set(doxyfile ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
+if(NOT DOXYGEN_FOUND)
 
-    configure_file(${doxyfile_in} ${doxyfile} @ONLY)
+    message(WARNING  "Doxygen could not be found.")
 
-	ADD_CUSTOM_TARGET(api_doc ALL 
-					COMMAND ${DOXYGEN_EXECUTABLE} ${doxyfile}
-					WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR})
-ENDIF (DOXYGEN_FOUND)
+else()
+	
+	if(NOT EXISTS ${FILTER_PROTO2CPP_PY_PATH}/proto2cpp.py)
+	
+	message(WARNING  "${FILTER_PROTO2CPP_PY_PATH}/proto2cpp.py could not be found.")
+
+	else()
+	
+		set(doxyfile_in ${CMAKE_CURRENT_SOURCE_DIR}/doxygen-config.cmake.in)
+		set(doxyfile ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
+
+		configure_file(${doxyfile_in} ${doxyfile} @ONLY)
+
+		ADD_CUSTOM_TARGET(api_doc ALL 
+		COMMAND ${DOXYGEN_EXECUTABLE} ${doxyfile}
+		WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR})
+	
+	endif(NOT EXISTS ${FILTER_PROTO2CPP_PY_PATH}/proto2cpp.py)
+	
+endif(NOT DOXYGEN_FOUND)

README.md

@@ -76,3 +76,15 @@ Packaging
 A specification to package sensor models using OSI as (extended)
 Functional Mock-up Units (FMUs) for use in simulation environments
 is available [here](https://github.com/OpenSimulationInterface/osi-sensor-model-packaging).
+
+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: 
+```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.