summaryrefslogtreecommitdiff
path: root/documentation/CMakeLists.txt
diff options
context:
space:
mode:
authorAlbrecht Schlosser <albrechts.fltk@online.de>2023-09-07 13:41:47 +0200
committerAlbrecht Schlosser <albrechts.fltk@online.de>2023-09-07 18:34:04 +0200
commit41ca8f2050abde897628d6c690cd49be0686207a (patch)
treeff1809baa3e9e29fd5432c1748ee094c640e251f /documentation/CMakeLists.txt
parent14f85de28f45fae81ccdc7bdf5ffddd4a857c9ec (diff)
Update Doxyfile.in from doxygen version 1.5.5 to 1.8.14
Most (if not all) doxygen tags introduced after 1.5.5 are commented out to avoid doxygen warnings about obsolete or unknown tags, except those tags that need a specific value. Add 'HTML_COLORSTYLE = TOGGLE' (since 1.9.5) for better user experience. With this tag users can switch between dark and light mode *if* the docs were generated with doxygen 1.9.5 or later. Enable search engine. Log doxygen conversion errors and warnings to Doxy*_error.log, i.e. silence the doxygen conversion process. documentation/src/index.dox: Remove background color from html index page for better contrast when using dark mode.
Diffstat (limited to 'documentation/CMakeLists.txt')
-rw-r--r--documentation/CMakeLists.txt16
1 files changed, 9 insertions, 7 deletions
diff --git a/documentation/CMakeLists.txt b/documentation/CMakeLists.txt
index 9c97a14ea..9405b864a 100644
--- a/documentation/CMakeLists.txt
+++ b/documentation/CMakeLists.txt
@@ -76,6 +76,7 @@ if (GENERATE_DOCS)
string (REGEX REPLACE " .*$" "" DOXYGEN_VERSION_SHORT ${DOXYGEN_VERSION})
# strip trailing newline
string (REPLACE "\n" "" DOXYGEN_VERSION_SHORT "${DOXYGEN_VERSION_SHORT}")
+
endif (DOXYGEN_FOUND)
# configure copyright.dox (includes current year)
@@ -128,11 +129,13 @@ if (OPTION_BUILD_HTML_DOCUMENTATION)
# convert Doxyfile to current doxygen version
+ set (LOGFILE ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile_error.log)
add_custom_command (
OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
- COMMAND ${DOXYGEN_EXECUTABLE} -u -s - < Doxyfile.in > Doxyfile
+ COMMAND ${DOXYGEN_EXECUTABLE} -u -s - < Doxyfile.in > Doxyfile 2> ${LOGFILE}
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
- COMMENT "Converting Doxyfile to current doxygen version" VERBATIM
+ BYPRODUCTS ${LOGFILE}
+ COMMENT "Converting Doxyfile to doxygen version ${DOXYGEN_VERSION_SHORT}" VERBATIM
)
# generate HTML documentation
@@ -160,9 +163,6 @@ if (OPTION_BUILD_PDF_DOCUMENTATION)
set (GENERATE_LATEX YES)
set (LATEX_HEADER "${CMAKE_CURRENT_BINARY_DIR}/fltk-book.tex")
- # strip potential " (Git-hash)" from the original version
- string (REGEX REPLACE " .*$" "" DOXY_VERSION ${DOXYGEN_VERSION})
-
# configure Doxygen input file for PDF docs (Doxybook.in)
configure_file (
@@ -173,11 +173,13 @@ if (OPTION_BUILD_PDF_DOCUMENTATION)
# convert Doxybook to current doxygen version
+ set (LOGFILE ${CMAKE_CURRENT_BINARY_DIR}/Doxybook_error.log)
add_custom_command (
OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/Doxybook
- COMMAND ${DOXYGEN_EXECUTABLE} -u -s - < Doxybook.in > Doxybook
+ COMMAND ${DOXYGEN_EXECUTABLE} -u -s - < Doxybook.in > Doxybook 2> ${LOGFILE}
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
- COMMENT "Converting Doxybook to current doxygen version" VERBATIM
+ BYPRODUCTS ${LOGFILE}
+ COMMENT "Converting Doxybook to doxygen version ${DOXYGEN_VERSION_SHORT}" VERBATIM
)
# generate LaTeX title fltk-title.tex