1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
|
###############################################################################
# Top contributors (to current version):
# Aina Niemetz, Gereon Kremer, Mathias Preiner
#
# This file is part of the cvc5 project.
#
# Copyright (c) 2009-2025 by the authors listed in the file AUTHORS
# in the top-level source directory and their institutional affiliations.
# All rights reserved. See the file COPYING in the top-level source
# directory for licensing information.
# #############################################################################
#
# The build system configuration.
#
find_package(Doxygen REQUIRED)
# basic parameters
set(DOXYGEN_PROJECT_NAME "cvc5")
set(DOXYGEN_INPUT_DIR ${PROJECT_SOURCE_DIR}/include/cvc5)
set(DOXYGEN_OUTPUT_DIR ${CMAKE_CURRENT_BINARY_DIR}/doxygen)
set(DOXYGEN_INPUT "\
${DOXYGEN_INPUT_DIR}/cvc5.h \
${DOXYGEN_INPUT_DIR}/cvc5_parser.h \
${DOXYGEN_INPUT_DIR}/cvc5_kind.h \
${DOXYGEN_INPUT_DIR}/cvc5_types.h \
${DOXYGEN_INPUT_DIR}/cvc5_proof_rule.h \
${DOXYGEN_INPUT_DIR}/cvc5_skolem_id.h
")
set(DOXYGEN_INDEX_FILE ${DOXYGEN_OUTPUT_DIR}/xml/index.xml)
set(DOXYGEN_PREDEFINED "")
set(DOXYGEN_WARN_AS_ERROR NO)
if(TREAT_WARNING_AS_ERROR)
set(DOXYGEN_WARN_AS_ERROR FAIL_ON_WARNINGS)
endif()
# create doxygen config file
set(DOXYFILE_IN ${CMAKE_CURRENT_SOURCE_DIR}/../Doxyfile.in)
set(DOXYFILE_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
configure_file(${DOXYFILE_IN} ${DOXYFILE_OUT} @ONLY)
# make sure the outpur directory exists
file(MAKE_DIRECTORY ${DOXYGEN_OUTPUT_DIR})
# add the doxygen target
add_custom_command(
OUTPUT ${DOXYGEN_INDEX_FILE}
COMMAND Doxygen::doxygen ${DOXYFILE_OUT}
MAIN_DEPENDENCY ${DOXYFILE_OUT}
DEPENDS
${DOXYGEN_INPUT_DIR}/cvc5.h
${DOXYGEN_INPUT_DIR}/cvc5_parser.h
${DOXYGEN_INPUT_DIR}/cvc5_kind.h
${DOXYGEN_INPUT_DIR}/cvc5_types.h
${DOXYGEN_INPUT_DIR}/cvc5_proof_rule.h
${DOXYGEN_INPUT_DIR}/cvc5_skolem_id.h
COMMENT "Generating doxygen C++ API docs"
)
add_custom_target(docs-cpp DEPENDS ${DOXYGEN_INDEX_FILE})
# tell parent scope where to find the output xml
set(CPP_DOXYGEN_XML_DIR
"${DOXYGEN_OUTPUT_DIR}/xml"
PARENT_SCOPE
)
|
