Pushing some changes for basic doxygen file setup.

adding and changing the testing files.

Updated the Catch2 to be on version 2.13.4 until version 3 is stable. Got a semi hacky test in for now.

The instruction for CMake integration on Catch2 were failing. I am not sure why but spent a good chunk of time but couldn't figure it out.

Testing is done by using the new test command to compile and run the tests.

Author: LinuxDevon

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "third_party/Catch2"]
+	path = third_party/Catch2
+	url = https://github.com/catchorg/Catch2.git

CMakeLists.txt

@@ -1,6 +1,6 @@
 cmake_minimum_required(VERSION 3.10)
 
-project(DBC_Tests)
+project(DBC)
 
 # specify the C++ standard
 set(CMAKE_CXX_STANDARD 11)
@@ -14,4 +14,5 @@ set(CMAKE_CXX_FLAGS  "${CMAKE_CXX_FLAGS} ${GCC_COVERAGE_COMPILE_FLAGS}")
 include_directories(src)
 include_directories(test)
 add_subdirectory(test)
+add_subdirectory(doc)
 

doc/CMakeLists.txt

@@ -0,0 +1,22 @@
+# add a target to generate API documentation with Doxygen
+find_package(Doxygen)
+option(BUILD_DOCUMENTATION "Create and install the HTML based API documentation (requires Doxygen)" ${DOXYGEN_FOUND})
+
+if(BUILD_DOCUMENTATION)
+    if(NOT DOXYGEN_FOUND)
+        message(FATAL_ERROR "Doxygen is needed to build the documentation.")
+    endif()
+
+    set(doxyfile_in ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in)
+    set(doxyfile ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
+
+    configure_file(${doxyfile_in} ${doxyfile} @ONLY)
+
+    add_custom_target(doc
+        COMMAND ${DOXYGEN_EXECUTABLE} ${doxyfile}
+        WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+        COMMENT "Generating API documentation with Doxygen"
+        VERBATIM)
+
+    install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html DESTINATION share/doc)
+endif()

doc/Doxyfile.in

@@ -0,0 +1,11 @@
+PROJECT_NAME           = "@CMAKE_PROJECT_NAME@"
+PROJECT_NUMBER         = @VERSION_MAJOR@.@VERSION_MINOR@.@VERSION_PATCH@
+STRIP_FROM_PATH        = @PROJECT_SOURCE_DIR@ \
+                         @PROJECT_BINARY_DIR@
+INPUT                  = @doxy_main_page@ \
+                         @PROJECT_SOURCE_DIR@ \
+                         @PROJECT_BINARY_DIR@
+FILE_PATTERNS          = *.h \
+                         *.cc
+RECURSIVE              = YES
+USE_MDFILE_AS_MAINPAGE = @doxy_main_page@

src/dbc.hpp

@@ -34,3 +34,11 @@ std::istream & getline( std::istream & stream, std::string & line ) {
 
 }
 
+
+namespace dbc {
+
+class parser {
+
+};
+
+}

test/CMakeLists.txt

@@ -1 +1,10 @@
-add_executable(dbc_test main.cpp file_loading.cpp)
+project(tests VERSION 0.1.0)
+
+include_directories(SYSTEM ${PROJECT_SOURCE_DIR}/third_party/Catch2/single_include)
+
+add_executable(tests main.cpp file_loading.cpp)
+
+add_custom_target(test
+					COMMAND ${PROJECT_NAME}
+					WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
+					DEPENDS ${PROJECT_NAME})