summaryrefslogtreecommitdiff
path: root/cmake/DoxygenChecks.cmake
diff options
context:
space:
mode:
Diffstat (limited to 'cmake/DoxygenChecks.cmake')
-rw-r--r--cmake/DoxygenChecks.cmake13
1 files changed, 13 insertions, 0 deletions
diff --git a/cmake/DoxygenChecks.cmake b/cmake/DoxygenChecks.cmake
new file mode 100644
index 00000000..0bbc8226
--- /dev/null
+++ b/cmake/DoxygenChecks.cmake
@@ -0,0 +1,13 @@
+# Check doxygen build log and display any errors or warnings.
+
+message(STATUS "Checking for doxygen errors in ${logfile}")
+
+file(READ "${logfile}" LOG)
+string(LENGTH "${LOG}" LOGLEN)
+
+if(LOGLEN GREATER 0)
+ message(WARNING "Doxygen encountered undocumented code or errors in ${logfile}")
+ message("══════════════════════════════ UNDOCUMENTED CODE ══════════════════════════════")
+ message("${LOG}")
+ message("═════════════════════════════ END UNDOCUMENTED CODE ═══════════════════════════")
+endif()