summaryrefslogtreecommitdiff
path: root/docs/CMakeLists.txt
diff options
context:
space:
mode:
authorMichael Gottesman <mgottesman@apple.com>2014-03-07 19:19:28 +0000
committerMichael Gottesman <mgottesman@apple.com>2014-03-07 19:19:28 +0000
commitfac248734708670e898b814f88f5f262da774de3 (patch)
tree1a1dae57794663ba90074797f4f15ccef450eba2 /docs/CMakeLists.txt
parent3bfc4d8e13edd83534b733f0f1de5b1d5f6bf828 (diff)
downloadllvm-fac248734708670e898b814f88f5f262da774de3.tar.gz
llvm-fac248734708670e898b814f88f5f262da774de3.tar.bz2
llvm-fac248734708670e898b814f88f5f262da774de3.tar.xz
[docs] Teach CMake docs build how to generate Qt Creator help/documentation files.
Patch by Konrad Kleine. Differential Revision: http://llvm-reviews.chandlerc.com/D2967 git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@203272 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs/CMakeLists.txt')
-rw-r--r--docs/CMakeLists.txt40
1 files changed, 40 insertions, 0 deletions
diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt
index 8c49aa5e5f..f0aa9c257f 100644
--- a/docs/CMakeLists.txt
+++ b/docs/CMakeLists.txt
@@ -22,6 +22,40 @@ if (LLVM_ENABLE_DOXYGEN)
set(extra_search_mappings "")
endif()
+ # If asked, configure doxygen for the creation of a Qt Compressed Help file.
+ option(LLVM_ENABLE_DOXYGEN_QT_HELP
+ "Generate a Qt Compressed Help file." OFF)
+ if (LLVM_ENABLE_DOXYGEN_QT_HELP)
+ set(LLVM_DOXYGEN_QCH_FILENAME "org.llvm.qch" CACHE STRING
+ "Filename of the Qt Compressed help file")
+ set(LLVM_DOXYGEN_QHP_NAMESPACE "org.llvm" CACHE STRING
+ "Namespace under which the intermediate Qt Help Project file lives")
+ set(LLVM_DOXYGEN_QHP_CUST_FILTER_NAME "${PACKAGE_STRING}" CACHE STRING
+ "See http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-filters")
+ set(LLVM_DOXYGEN_QHP_CUST_FILTER_ATTRS "${PACKAGE_NAME},${PACKAGE_VERSION}" CACHE STRING
+ "See http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes")
+ find_program(LLVM_DOXYGEN_QHELPGENERATOR_PATH qhelpgenerator
+ DOC "Path to the qhelpgenerator binary")
+ if (NOT LLVM_DOXYGEN_QHELPGENERATOR_PATH)
+ message(FATAL_ERROR "Failed to find qhelpgenerator binary")
+ endif()
+
+ set(llvm_doxygen_generate_qhp "YES")
+ set(llvm_doxygen_qch_filename "${LLVM_DOXYGEN_QCH_FILENAME}")
+ set(llvm_doxygen_qhp_namespace "${LLVM_DOXYGEN_QHP_NAMESPACE}")
+ set(llvm_doxygen_qhelpgenerator_path "${LLVM_DOXYGEN_QHELPGENERATOR_PATH}")
+ set(llvm_doxygen_qhp_cust_filter_name "${LLVM_DOXYGEN_QHP_CUST_FILTER_NAME}")
+ set(llvm_doxygen_qhp_cust_filter_attrs "${LLVM_DOXYGEN_QHP_CUST_FILTER_ATTRS}")
+
+ else()
+ set(llvm_doxygen_generate_qhp "NO")
+ set(llvm_doxygen_qch_filename "")
+ set(llvm_doxygen_qhp_namespace "")
+ set(llvm_doxygen_qhelpgenerator_path "")
+ set(llvm_doxygen_qhp_cust_filter_name "")
+ set(llvm_doxygen_qhp_cust_filter_attrs "")
+ endif()
+
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/doxygen.cfg.in
${CMAKE_CURRENT_BINARY_DIR}/doxygen.cfg @ONLY)
@@ -33,6 +67,12 @@ if (LLVM_ENABLE_DOXYGEN)
set(enable_server_based_search)
set(enable_external_search)
set(extra_search_mappings)
+ set(llvm_doxygen_generate_qhp)
+ set(llvm_doxygen_qch_filename)
+ set(llvm_doxygen_qhp_namespace)
+ set(llvm_doxygen_qhelpgenerator_path)
+ set(llvm_doxygen_qhp_cust_filter_name)
+ set(llvm_doxygen_qhp_cust_filter_attrs)
add_custom_target(doxygen-llvm
COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/doxygen.cfg