mirror of
https://gitlab.freedesktop.org/monado/monado.git
synced 2025-01-03 21:56:06 +00:00
cc4007a69e
We now have a cmake-format config file. We no longer use list variables for sources, instead using target_sources when we need to add, in accordance with current best practice. (This makes it a lot easier to edit too.) There's no more include_directories(), add_definitions(), or other gently-deprecated directory-scoped commands, nor any CMake scripts that include a parent directory reference (named targets instead)
56 lines
1.8 KiB
CMake
56 lines
1.8 KiB
CMake
# Copyright 2018-2020, Collabora, Ltd.
|
|
# SPDX-License-Identifier: BSL-1.0
|
|
|
|
# check if Doxygen is installed
|
|
find_package(Doxygen)
|
|
|
|
# cmake-format: off
|
|
|
|
cmake_dependent_option(BUILD_DOC "Build documentation" ON "DOXYGEN_FOUND" OFF)
|
|
cmake_dependent_option(BUILD_DOC_WARN_UNDOCUMENTED "Warn on undocumented entities when building documentation" OFF "DOXYGEN_FOUND" OFF)
|
|
cmake_dependent_option(BUILD_DOC_EXTRACT_ALL "Extract all entities for documentation, not just documented ones (conflicts with BUILD_DOC_WARN_UNDOCUMENTED)" ON "DOXYGEN_FOUND AND NOT BUILD_DOC_WARN_UNDOCUMENTED" OFF)
|
|
|
|
# cmake-format: on
|
|
|
|
if(BUILD_DOC)
|
|
if(BUILD_DOC_WARN_UNDOCUMENTED)
|
|
set(DOXYGEN_WARN_UNDOCUMENTED YES)
|
|
else()
|
|
set(DOXYGEN_WARN_UNDOCUMENTED NO)
|
|
endif()
|
|
if(BUILD_DOC_EXTRACT_ALL)
|
|
set(DOXYGEN_EXTRACT_ALL YES)
|
|
else()
|
|
set(DOXYGEN_EXTRACT_ALL NO)
|
|
endif()
|
|
|
|
# set input and output files
|
|
set(DOXYGEN_IN ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in)
|
|
set(DOXYGEN_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
|
|
|
|
set(CURBUILDDIR ${CMAKE_CURRENT_BINARY_DIR})
|
|
set(SRCDIR ${PROJECT_SOURCE_DIR})
|
|
set(BUILDDIR ${PROJECT_BINARY_DIR})
|
|
# request to configure the file
|
|
configure_file(${DOXYGEN_IN} ${DOXYGEN_OUT} @ONLY)
|
|
|
|
# copy the schema
|
|
configure_file(
|
|
${CMAKE_CURRENT_SOURCE_DIR}/example_configs/config_v0.schema.json
|
|
${CMAKE_CURRENT_BINARY_DIR}/html/config_v0.schema.json @ONLY
|
|
)
|
|
configure_file(
|
|
${CMAKE_CURRENT_SOURCE_DIR}/example_configs/config_v0.schema.json.license
|
|
${CMAKE_CURRENT_BINARY_DIR}/html/config_v0.schema.json.license @ONLY
|
|
)
|
|
|
|
# note the option ALL which allows to build the docs together with the application
|
|
add_custom_target(
|
|
doc_doxygen ALL
|
|
COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYGEN_OUT}
|
|
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
|
|
COMMENT "Generating API documentation with Doxygen"
|
|
VERBATIM
|
|
)
|
|
endif()
|