feat(CTemplate): add Doxygen

C_Tempate/CMakeLists.txt

@@ -5,6 +5,8 @@ set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
 
 # Turn on testing by default
 option(BUILD_TESTING "Build tests" ON)
+# Turn off documentation build by default
+option(BUILD_DOC "Build documentation" OFF)
 # Turn off coverage by default
 option(ENABLE_COVERAGE "Enable test coverage" ON)
 
@@ -24,12 +26,6 @@ FUNCTION(PREPEND var )
    SET(${var} "${listVar}" PARENT_SCOPE)
 ENDFUNCTION(PREPEND)
 
-# After a normal build, we can specify the location of various outputs of the
-# build. We put executables and static libraries outside the build directory in
-# bin/ and lib/, respectively.
-set(CMAKE_RUNTIME_OUTPUT_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/bin")
-set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/lib")
-
 # Include source code and headers. This calls the CMakeLists.txt in each
 # subdirectory. These can define their own libraries, executables, etc. as targets,
 # but here we define all exportable targets in the root CMakeLists.txt.
@@ -50,3 +46,6 @@ endif()
 add_executable(${PROJECT_NAME} ${SRC} ${INC})
 target_include_directories(${PROJECT_NAME} PRIVATE include)
 
+if(BUILD_DOC)
+   add_subdirectory(docs)
+endif()

C_Tempate/docs/CMakeLists.txt

@@ -0,0 +1,20 @@
+# check if Doxygen is installed
+find_package(Doxygen)
+if (DOXYGEN_FOUND)
+    # set input and output files
+    set(DOXYGEN_IN ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile)
+    set(DOXYGEN_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
+
+    # request to configure the file
+    configure_file(${DOXYGEN_IN} ${DOXYGEN_OUT} @ONLY)
+    message("Doxygen build started")
+
+    # note the option ALL which allows to build the docs together with the application
+    add_custom_target(doc ALL
+        COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYGEN_OUT}
+        WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+        COMMENT "Generating documentation with Doxygen"
+        VERBATIM )
+else (DOXYGEN_FOUND)
+    message("Doxygen needs to be installed to generate the documentation")
+endif (DOXYGEN_FOUND)