92 lines
3.3 KiB
CMake
92 lines
3.3 KiB
CMake
#
|
|
# This file is part of KDDockWidgets.
|
|
#
|
|
# SPDX-FileCopyrightText: 2020-2022 Klarälvdalens Datakonsult AB, a KDAB Group
|
|
# company <info@kdab.com> Author: Allen Winter <allen.winter@kdab.com>
|
|
#
|
|
# SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only
|
|
#
|
|
# Contact KDAB at <info@kdab.com> for commercial licensing options.
|
|
#
|
|
|
|
# dot should come with Doxygen find_package(Doxygen)
|
|
if(DOXYGEN_DOT_EXECUTABLE)
|
|
set(HAVE_DOT "YES")
|
|
else()
|
|
set(HAVE_DOT "NO")
|
|
message(
|
|
STATUS
|
|
"Unable to provide inheritance diagrams for the API documentation. To fix, install the graphviz project from https://www.graphviz.org"
|
|
)
|
|
endif()
|
|
|
|
# qhelpgenerator
|
|
find_program(QHELPGEN_EXECUTABLE qhelpgenerator HINTS ${QT_INSTALL_BINS})
|
|
if(QHELPGEN_EXECUTABLE)
|
|
set(HAVE_QHELPGEN "YES")
|
|
else()
|
|
set(HAVE_QHELPGEN "NO")
|
|
message(
|
|
STATUS
|
|
"Unable to generate the API documentation in qch format. To fix, install the qthelpgenerator program which comes with Qt."
|
|
)
|
|
endif()
|
|
|
|
find_file(
|
|
QDOC_QTCORE_TAG qtcore.tags
|
|
HINTS ${QT_INSTALL_DOCS}/qtcore
|
|
HINTS ${QT_INSTALL_DATA}/doc/qtcore)
|
|
set(QDOC_TAG_DIR "<QDOC_TAG_DIR_not_found>")
|
|
if(QDOC_QTCORE_TAG)
|
|
get_filename_component(QDOC_TAG_DIR ${QDOC_QTCORE_TAG} DIRECTORY)
|
|
get_filename_component(QDOC_TAG_DIR ${QDOC_TAG_DIR} DIRECTORY)
|
|
endif()
|
|
|
|
file(GLOB _dox_deps *.dox *.html)
|
|
set(DOXYGEN_OUTPUT_DIR ${CMAKE_CURRENT_BINARY_DIR})
|
|
|
|
# apidox generation using doxygen
|
|
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.cmake
|
|
${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
|
|
|
|
add_custom_command(
|
|
OUTPUT ${DOXYGEN_OUTPUT_DIR}/qch/kddockwidgets-api.qch
|
|
COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
|
|
# handle a bug in doxygen where image files referred to in markdown are not
|
|
# copied the output
|
|
COMMAND
|
|
${CMAKE_COMMAND} -E copy_if_different
|
|
${CMAKE_CURRENT_SOURCE_DIR}/../../screencap.gif ${DOXYGEN_OUTPUT_DIR}/html
|
|
# copy some files by-hand that are referred to by the markdown README
|
|
COMMAND ${CMAKE_COMMAND} -E copy_if_different
|
|
${CMAKE_SOURCE_DIR}/README-bindings.md ${DOXYGEN_OUTPUT_DIR}/html
|
|
COMMAND ${CMAKE_COMMAND} -E make_directory ${DOXYGEN_OUTPUT_DIR}/html/LICENSES
|
|
COMMAND
|
|
${CMAKE_COMMAND} -E copy_if_different
|
|
${CMAKE_SOURCE_DIR}/LICENSES/GPL-2.0-only.txt
|
|
${DOXYGEN_OUTPUT_DIR}/html/LICENSES
|
|
COMMAND
|
|
${CMAKE_COMMAND} -E copy_if_different
|
|
${CMAKE_SOURCE_DIR}/LICENSES/GPL-3.0-only.txt
|
|
${DOXYGEN_OUTPUT_DIR}/html/LICENSES
|
|
COMMAND ${CMAKE_COMMAND} -E make_directory ${DOXYGEN_OUTPUT_DIR}/html/docs
|
|
COMMAND
|
|
${CMAKE_COMMAND} -E copy_if_different
|
|
${CMAKE_SOURCE_DIR}/docs/KDDockWidgets-CopyrightAssignmentForm.pdf
|
|
${DOXYGEN_OUTPUT_DIR}/html/docs
|
|
COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_SOURCE_DIR}/examples
|
|
${DOXYGEN_OUTPUT_DIR}/html/examples
|
|
DEPENDS ${_dox_deps} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
|
|
WORKING_DIRECTORY ${CMAKE_BINARY_DIR})
|
|
add_custom_target(kddockwidgets-api.qch ALL
|
|
DEPENDS ${DOXYGEN_OUTPUT_DIR}/qch/kddockwidgets-api.qch)
|
|
add_custom_target(docs DEPENDS kddockwidgets-api.qch)
|
|
|
|
set(QCH_INSTALL_DIR
|
|
${INSTALL_DOC_DIR}
|
|
CACHE STRING "Install location of Qt Assistant help files.")
|
|
install(FILES ${DOXYGEN_OUTPUT_DIR}/qch/kddockwidgets-api.qch
|
|
DESTINATION ${QCH_INSTALL_DIR})
|
|
install(FILES ${DOXYGEN_OUTPUT_DIR}/kddockwidgets.tags
|
|
DESTINATION ${INSTALL_DOC_DIR})
|