Update doxygen setup and clarified documentations

.clang-format

@@ -36,10 +36,8 @@ ExperimentalAutoDetectBinPacking: false
 FixNamespaceComments: false
 IncludeBlocks: Regroup
 IncludeCategories:
-  - Regex:           '^<eve/'
-    Priority:        0
   - Regex:           '<[[:alnum:].]+>'
-    Priority:        1
+    Priority:        0
 #IndentCaseBlocks: true
 IndentCaseLabels: false
 IndentPPDirectives: AfterHash

.github/actions/run_tests/Dockerfile

@@ -1,5 +1,5 @@
 # Container image that runs your code
-FROM jfalcou/compilers:v3
+FROM jfalcou/compilers:v4
 
 # Copies your code file from your action repository to the filesystem path `/` of the container
 COPY entrypoint.sh /entrypoint.sh

.github/actions/run_tests/entrypoint.sh

@@ -7,7 +7,7 @@ cmake .. -G Ninja -DCMAKE_CXX_COMPILER="$1"
 echo "::endgroup::"
 
 echo "::group::Compiling test" ;
-ninja unit -k 0 ;
+ninja -k 0 ;
 if [ "$?" -ne "0" ]
 then
   echo "::error Tests can not be compiled!" ;

.github/workflows/main.yml

@@ -8,7 +8,7 @@ on:
       - main
 
 jobs:
-  gcc-11:
+  gcc:
     runs-on: ubuntu-latest
     steps:
       - name: Fetch current branch
@@ -18,7 +18,7 @@ jobs:
         with:
           compiler: 'g++-11'
 
-  clang-12:
+  clang:
     runs-on: ubuntu-latest
     steps:
       - name: Fetch current branch

CMakeLists.txt

@@ -39,7 +39,8 @@ add_library(raberu::raberu ALIAS raberu_lib)
 ##==================================================================================================
 ## Options
 ##==================================================================================================
-option( RABERU_BUILD_TEST  "Build tests for raberu" ON )
+option( RABERU_BUILD_TEST  "Build tests for raberu" ON  )
+option( RABERU_BUILD_DOCS  "Build docs for raberu"  OFF )
 
 ##==================================================================================================
 ## Test target
@@ -48,3 +49,27 @@ if( RABERU_BUILD_TEST )
   include(CTest)
   add_subdirectory(${PROJECT_SOURCE_DIR}/test/)
 endif()
+
+
+##==================================================================================================
+## Add Doxygen building target
+##==================================================================================================
+if( RABERU_BUILD_DOCS )
+  find_package(Doxygen QUIET)
+
+  if (DOXYGEN_FOUND)
+    message( STATUS "[raberu] Doxygen available")
+  else (DOXYGEN_FOUND)
+    message( STATUS "[raberu] Doxygen need to be installed to generate the doxygen documentation")
+  endif (DOXYGEN_FOUND)
+
+  if (DOXYGEN_FOUND)
+    set(DOXYGEN_CONFIG ${PROJECT_SOURCE_DIR}/doc/Doxyfile)
+    add_custom_target ( rbr-doxygen
+                        COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYGEN_CONFIG}
+                        WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/doc
+                        COMMENT "[raberu] Generating API documentation with Doxygen"
+                        VERBATIM
+                      )
+  endif (DOXYGEN_FOUND)
+endif()

appveyor.yml

@@ -9,8 +9,8 @@ build_script:
 - mkdir build
 - cd build
 - cmake -G "Visual Studio 17 2022" -A x64 ..
-- cmake --build . --target unit --verbose --config Debug
-- cmake --build . --target unit --verbose --config Release
+- cmake --build . --verbose --config Debug
+- cmake --build . --verbose --config Release
 
 test_script:
 - ctest -C Release -VV