2017-10-31 22:10:14 +00:00
|
|
|
##============================================================================
|
|
|
|
## Copyright (c) Kitware, Inc.
|
|
|
|
## All rights reserved.
|
|
|
|
## See LICENSE.txt for details.
|
2019-04-15 23:24:21 +00:00
|
|
|
##
|
2017-10-31 22:10:14 +00:00
|
|
|
## 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)
|
|
|
|
|
2023-08-18 19:04:08 +00:00
|
|
|
#-----------------------------------------------------------------------------
|
|
|
|
# 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()
|
|
|
|
|
2017-10-31 22:10:14 +00:00
|
|
|
#-----------------------------------------------------------------------------
|
|
|
|
# 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)
|
|
|
|
|
2023-08-18 19:04:08 +00:00
|
|
|
to_yes_no(VTKm_ENABLE_USERS_GUIDE)
|
|
|
|
to_yes_no(VTKm_Doxygen_HTML_output)
|
|
|
|
|
2017-10-31 22:10:14 +00:00
|
|
|
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
|
|
|
|
)
|