From da64ca577c9215105099e1c868470b22e8405a94 Mon Sep 17 00:00:00 2001
From: Nick Bolton <nick@symless.com>
Date: Thu, 31 Oct 2024 11:58:44 +0000
Subject: [PATCH] docs: Improve error messages around Doxygen

---
 doc/CMakeLists.txt | 12 +++++++-----
 1 file changed, 7 insertions(+), 5 deletions(-)

diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
index 865366664..0f2035af4 100644
--- a/doc/CMakeLists.txt
+++ b/doc/CMakeLists.txt
@@ -2,9 +2,10 @@
 # SPDX-License-Identifier: MIT
 
 find_package(Doxygen QUIET)
-option(BUILD_DOCS "Build and Install Documents" ${DOXYGEN_FOUND})
+option(BUILD_DOCS "Build and install documents" ${DOXYGEN_FOUND})
+
+if (BUILD_DOCS AND DOXYGEN_FOUND)
 
-if(BUILD_DOCS)
   set(DOXYGEN_EXTRACT_ALL YES)
   set(DOXYGEN_STRIP_FROM_PATH ${CMAKE_SOURCE_DIR})
   set(DOXYGEN_USE_MDFILE_AS_MAINPAGE mainpage.md)
@@ -12,7 +13,7 @@ if(BUILD_DOCS)
 
   # Files used to make our documents
   # User facing documents will not include doxy comments in source code
-  doxygen_add_docs(user-docs ${CMAKE_SOURCE_DIR}/doc COMMENT "Generating User Documentation" ALL)
+  doxygen_add_docs(user-docs ${CMAKE_SOURCE_DIR}/doc COMMENT "Generating user documentation" ALL)
 
   # HACK Only these will show in your IDE
   target_sources(user-docs PRIVATE
@@ -24,6 +25,7 @@ if(BUILD_DOCS)
     DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/html"
     DESTINATION ${CMAKE_INSTALL_DOCDIR}
     COMPONENT deskflow_docs)
-elseif(NOT DOXYGEN_FOUND)
-  message(STATUS:"Unable to build documentation Doxygen not found")
+
+else()
+  message(STATUS "Doxygen not found, skipping docs build")
 endif()