mirror of
https://gitlab.kitware.com/vtk/vtk-m
synced 2024-07-06 07:17:25 +00:00
3d3b66865f
The Doxygen html generation takes a lot more time than the xml generation. If all you want from Doxygen is the xml for the user's guide, that can be frustrating. Add an option to turn off the xml.
59 lines
2.1 KiB
CMake
59 lines
2.1 KiB
CMake
##============================================================================
|
|
## Copyright (c) Kitware, Inc.
|
|
## All rights reserved.
|
|
## See LICENSE.txt for details.
|
|
##
|
|
## This software is distributed WITHOUT ANY WARRANTY; without even
|
|
## the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
|
|
## PURPOSE. See the above copyright notice for more information.
|
|
##============================================================================
|
|
|
|
#-----------------------------------------------------------------------------
|
|
# Find Doxygen
|
|
#-----------------------------------------------------------------------------
|
|
find_package(Doxygen REQUIRED)
|
|
|
|
#-----------------------------------------------------------------------------
|
|
# Function to turn CMake booleans to `YES` or `NO` as expected by Doxygen
|
|
#-----------------------------------------------------------------------------
|
|
function(to_yes_no variable)
|
|
if(${variable})
|
|
set(${variable} YES PARENT_SCOPE)
|
|
else()
|
|
set(${variable} NO PARENT_SCOPE)
|
|
endif()
|
|
endfunction()
|
|
|
|
#-----------------------------------------------------------------------------
|
|
# Configure Doxygen
|
|
#-----------------------------------------------------------------------------
|
|
set(VTKm_DOXYGEN_HAVE_DOT ${DOXYGEN_DOT_FOUND})
|
|
set(VTKm_DOXYGEN_DOT_PATH ${DOXYGEN_DOT_PATH})
|
|
set(VTKm_DOXYFILE ${CMAKE_CURRENT_BINARY_DIR}/docs/doxyfile)
|
|
|
|
to_yes_no(VTKm_ENABLE_USERS_GUIDE)
|
|
to_yes_no(VTKm_Doxygen_HTML_output)
|
|
|
|
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/CMake/doxyfile.in ${VTKm_DOXYFILE}
|
|
@ONLY)
|
|
|
|
#-----------------------------------------------------------------------------
|
|
# Run Doxygen
|
|
#-----------------------------------------------------------------------------
|
|
if(WIN32)
|
|
set(doxygen_redirect NUL)
|
|
else()
|
|
set(doxygen_redirect /dev/null)
|
|
endif()
|
|
add_custom_command(
|
|
OUTPUT ${VTKm_BINARY_DIR}/docs/doxygen
|
|
COMMAND ${DOXYGEN_EXECUTABLE} ${VTKm_DOXYFILE} > ${doxygen_redirect}
|
|
MAIN_DEPENDENCY ${CMAKE_CURRENT_SOURCE_DIR}/CMake/doxyfile.in
|
|
DEPENDS ${VTKm_DOXYFILE}
|
|
COMMENT "Generating VTKm Documentation"
|
|
)
|
|
add_custom_target(VTKmDoxygenDocs
|
|
ALL
|
|
DEPENDS ${VTKm_BINARY_DIR}/docs/doxygen
|
|
)
|