Fail on doxygen warnings

qgis · Oct 22, 2020 · ee6ab3c · ee6ab3c
1 parent 7183966
commit ee6ab3c
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 4 deletions.
diff --git a/.github/workflows/code_layout.yml b/.github/workflows/code_layout.yml
@@ -38,8 +38,8 @@ jobs:
         run: |
          mkdir build
          cd build
-         cmake -DWITH_SERVER=ON -DUSE_CCACHE=OFF -DWITH_CORE=OFF -DWITH_APIDOC=ON -DWITH_ASTYLE=ON -DENABLE_TESTS=ON -DWITH_DOT=NO -DPEDANTIC=ON ..
-          make -j3
+         cmake -DWITH_SERVER=ON -DUSE_CCACHE=OFF -DWITH_CORE=OFF -DWITH_APIDOC=ON -DWITH_ASTYLE=ON -DENABLE_TESTS=ON -DWITH_DOT=NO -DWERROR=ON ..
+          make -j3 apidoc
       - name: Run Tests
         run: cd build && ctest -V -R PyQgsDocCoverage
 

diff --git a/cmake_templates/Doxyfile.in b/cmake_templates/Doxyfile.in
@@ -753,7 +753,7 @@ WARN_NO_PARAMDOC       = NO
 # a warning is encountered.
 # The default value is: NO.
 
-WARN_AS_ERROR          = NO
+WARN_AS_ERROR          = @DOXYGEN_WARN_AS_ERROR@
 
 # The WARN_FORMAT tag determines the format of the warning messages that doxygen
 # can produce. The string should contain the $file, $line, and $text tags, which

diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
@@ -142,9 +142,14 @@ IF(WITH_APIDOC)
 
     STRING(REPLACE ";" " " DOXYGEN_INPUT "${DOXYGEN_INPUT}")
 
+    IF(WERROR)
+      SET (DOXYGEN_WARN_AS_ERROR "YES")
+    ELSE(WERROR)
+      SET (DOXYGEN_WARN_AS_ERROR "NO")
+    ENDIF(WERROR)
     CONFIGURE_FILE(${CMAKE_SOURCE_DIR}/cmake_templates/Doxyfile.in ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY)
 
-    SET (DOXYGEN_ON_DEMAND FALSE CACHE BOOL "Determines whether the QGIS API doxygen documentation should be build on demand only")
+    SET (DOXYGEN_ON_DEMAND FALSE CACHE BOOL "Determines whether the QGIS API doxygen documentation should be built on demand through the target apidoc only. If set to false it is added to the target ALL.")
 
     IF(DOXYGEN_ON_DEMAND)
       ADD_CUSTOM_TARGET(apidoc DEPENDS ${QHP_FILES})