doc.cmake

Go to the documentation of this file.

# Copyright (c) 2023 David Guibert
# Copyright (c) 2024 Niclas Schroeter
# All rights reserved.
#
# SPDX-License-Identifier: Apache-2.0
 
set_property(GLOBAL PROPERTY doc_can_use_system TRUE)
if(doc_enabled)
    message(STATUS "DOC: enabled")
    
    find_package(Doxygen
             REQUIRED dot)
 
    set(DOXYGEN_GENERATE_TREEVIEW      YES) # optional. Also works without treeview
    set(DOXYGEN_DISABLE_INDEX NO)
    set(DOXYGEN_FULL_SIDEBAR NO)
    set(DOXYGEN_HTML_EXTRA_STYLESHEET  ${CMAKE_SOURCE_DIR}/doc/doxygen-awesome.css)
    set(DOXYGEN_HTML_COLORSTYLE        LIGHT) # required with Doxygen >= 1.9.5
    
    add_executable(CMakeDoxygenFilter ${CMAKE_SOURCE_DIR}/doc/CMakeDoxygenFilter.cpp)
    set(cmakedoxygenfilter_exe ${CMAKE_BINARY_DIR}/CMakeDoxygenFilter)
 
    # use the CMake doxygen filter for .cmake files
    set(DOXYGEN_FILTER_PATTERNS *.cmake=${cmakedoxygenfilter_exe})
    set(DOXYGEN_FILE_PATTERNS          *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.idl *.ddl *.odl *.h *.hh *.hxx *.hpp *.h++ *.l *.cs *.d *.php *.php4 *.php5 *.phtml *.inc *.m *.markdown *.md *.mm *.dox *.py *.pyw *.f90 *.f95 *.f03 *.f08 *.f18 *.f *.for *.vhd *.vhdl *.ucf *.qsf *.ice *.cmake)
 
    set(DOXYGEN_EXTRACT_ALL YES)
    set(DOXYGEN_QUIET YES)
    set(DOXYGEN_USE_MDFILE_AS_MAINPAGE README.md)
 
    doxygen_add_docs(doxygen
      ${CMAKE_SOURCE_DIR}/README.md
      ${CMAKE_SOURCE_DIR}/doc
      ${CMAKE_SOURCE_DIR}/cmake
      ${CMAKE_SOURCE_DIR}/projects
      ALL
      COMMENT "Generate documentation"
    )
    add_dependencies(doxygen CMakeDoxygenFilter)
endif(doc_enabled)