Refs #20631. Add support for CMAKE_COMPILE_WARNING_AS_ERROR

Signed-off-by: Ricardo González Moreno <ricardo@richiware.dev>

Author: richiware

CMakeLists.txt

@@ -29,6 +29,11 @@ string(REGEX REPLACE "^version = u'([0-9]+.[0-9]+.[0-9]+)'"
 
 project(fastdds-docs VERSION "${LIB_VERSION_STR}" LANGUAGES C CXX)
 
+# In case CMake version less than 3.24, add the option CMAKE_COMPILE_WARNING_AS_ERROR.
+if (${CMAKE_VERSION} VERSION_LESS "3.24")
+    option(CMAKE_COMPILE_WARNING_AS_ERROR "Treat warnings as errors" OFF)
+endif()
+
 
 ####################################################################################################
 # Build Doxygen documentation
@@ -125,7 +130,9 @@ if (BUILD_DOCUMENTATION)
     # Generate the sphinx documentation
     add_custom_target(Sphinx ALL
         COMMAND
-        ${SPHINX_EXECUTABLE} -b ${FASTDDS_DOCS_BUILDER}
+        ${SPHINX_EXECUTABLE}
+        $<$<BOOL:${CMAKE_COMPILE_WARNING_AS_ERROR}>:-W>
+        -b ${FASTDDS_DOCS_BUILDER}
         # Tell Breathe where to find the Doxygen output
         -D breathe_projects.FastDDS=${DOXYGEN_OUTPUT_DIR}/xml
         ${PYTHON_EXTRA_FLAG}

colcon.meta

@@ -1,11 +1,12 @@
 names:
     fastdds:
         cmake-args:
-            - "-DSECURITY=ON"
+            - -DSECURITY=ON
     fastdds_python:
         cmake-args:
-            - "-DBUILD_DOCUMENTATION=ON"
+            - -DBUILD_DOCUMENTATION=ON
     fastdds-docs:
         cmake-args:
-            - "-DBUILD_DOCUMENTATION=ON"
-            - "-DCOMPILE_TESTS=ON"
+            - -DBUILD_DOCUMENTATION=ON
+            - -DCMAKE_COMPILE_WARNING_AS_ERROR=ON
+            - -DCOMPILE_TESTS=ON