mirrors/monado
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/monado/monado.git synced 2024-12-28 18:46:18 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
monado/doc/CMakeLists.txt

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

73 lines
2.1 KiB
CMake
Raw Permalink Normal View History

cmake: Switch to a new way of setting options more in line with expectations. If you explicitly request an option, and it's not available due to dependencies, we now error out instead of silently changing the value.
2022-05-03 16:57:38 +00:00
# Copyright 2018-2022, Collabora, Ltd.
xrt: Add all of Monado
2019-03-18 05:52:32 +00:00
# SPDX-License-Identifier: BSL-1.0
# check if Doxygen is installed
find_package(Doxygen)
cmake: Substantial cleanups and simplifications 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)
2021-11-11 23:41:58 +00:00
doc: Do not build documentation by default
2023-06-29 16:17:51 +00:00
option_with_deps(
BUILD_DOC "Build documentation"
DEFAULT OFF
DEPENDS DOXYGEN_FOUND
)
cmake: Switch to a new way of setting options more in line with expectations. If you explicitly request an option, and it's not available due to dependencies, we now error out instead of silently changing the value.
2022-05-03 16:57:38 +00:00
option_with_deps(
BUILD_DOC_WARN_UNDOCUMENTED "Warn on undocumented entities when building documentation"
DEFAULT OFF
DEPENDS DOXYGEN_FOUND
)
option_with_deps(
BUILD_DOC_EXTRACT_ALL
build,scripts: Word choice/clarity
2022-05-17 22:09:20 +00:00
"Extract all entities for documentation, not only documented ones (conflicts with BUILD_DOC_WARN_UNDOCUMENTED)"
cmake: Switch to a new way of setting options more in line with expectations. If you explicitly request an option, and it's not available due to dependencies, we now error out instead of silently changing the value.
2022-05-03 16:57:38 +00:00
DEFAULT OFF
DEPENDS DOXYGEN_FOUND "NOT BUILD_DOC_WARN_UNDOCUMENTED"
)
cmake: Substantial cleanups and simplifications 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)
2021-11-11 23:41:58 +00:00
xrt: Add all of Monado
2019-03-18 05:52:32 +00:00
if(BUILD_DOC)
cmake: Tidy whitespace (NFC)
2020-04-29 08:12:19 +00:00
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()
xrt: Add all of Monado
2019-03-18 05:52:32 +00:00
cmake: Tidy whitespace (NFC)
2020-04-29 08:12:19 +00:00
# set input and output files
set(DOXYGEN_IN ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in)
set(DOXYGEN_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
xrt: Add all of Monado
2019-03-18 05:52:32 +00:00
cmake: Tidy whitespace (NFC)
2020-04-29 08:12:19 +00:00
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)
xrt: Add all of Monado
2019-03-18 05:52:32 +00:00
doc: Add json schema for new calibration file
2021-11-23 19:37:52 +00:00
# copy the schemas
cmake: Substantial cleanups and simplifications 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)
2021-11-11 23:41:58 +00:00
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
)
doc: Add json schema for new calibration file
2021-11-23 19:37:52 +00:00
configure_file(
${CMAKE_CURRENT_SOURCE_DIR}/example_configs/calibration_v2.schema.json
${CMAKE_CURRENT_BINARY_DIR}/html/calibration_v2.schema.json @ONLY
)
configure_file(
${CMAKE_CURRENT_SOURCE_DIR}/example_configs/calibration_v2.schema.json.license
${CMAKE_CURRENT_BINARY_DIR}/html/calibration_v2.schema.json.license @ONLY
)
doc: Add JSON Schema
2021-04-23 22:25:07 +00:00
cmake: Tidy whitespace (NFC)
2020-04-29 08:12:19 +00:00
# note the option ALL which allows to build the docs together with the application
cmake: Substantial cleanups and simplifications 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)
2021-11-11 23:41:58 +00:00
add_custom_target(
doc_doxygen ALL
cmake: Tidy whitespace (NFC)
2020-04-29 08:12:19 +00:00
COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYGEN_OUT}
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
COMMENT "Generating API documentation with Doxygen"
VERBATIM
)
xrt: Add all of Monado
2019-03-18 05:52:32 +00:00
endif()
Reference in a new issue Copy permalink