2012-02-13 10:42:26 +01:00
|
|
|
# Generate target to build the html documentation through CMake tool
|
|
|
|
# After having configured the project with the BUILD_DOC option you can run make doc
|
2011-10-06 10:41:49 +02:00
|
|
|
# to generate the html documentation in the doc/html repository of the build folder.
|
|
|
|
|
|
|
|
# Try to find the doxygen tool
|
2012-08-30 19:14:39 +02:00
|
|
|
find_package(Doxygen)
|
2010-10-22 20:41:17 +02:00
|
|
|
|
2012-08-30 19:14:39 +02:00
|
|
|
if(DOXYGEN_FOUND)
|
2011-10-06 10:41:49 +02:00
|
|
|
# Configure the doxygen config file with variable from CMake and move it
|
2012-08-30 19:14:39 +02:00
|
|
|
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.dox.cmake.in
|
2012-02-13 10:42:26 +01:00
|
|
|
${CMAKE_BINARY_DIR}/doc/Doxyfile-html.dox @ONLY)
|
2012-03-02 16:21:51 +01:00
|
|
|
|
2012-02-13 10:42:26 +01:00
|
|
|
# Configure the html mainpage file of the doxygen documentation with variable
|
2012-08-30 19:20:03 +02:00
|
|
|
# from CMake and move it
|
2012-08-30 19:14:39 +02:00
|
|
|
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/mainpage.dox.cmake
|
2012-02-13 10:42:26 +01:00
|
|
|
${CMAKE_BINARY_DIR}/doc/mainpage.dox @ONLY)
|
2011-10-06 10:41:49 +02:00
|
|
|
|
|
|
|
# Generate new target to build the html documentation
|
2012-08-30 19:14:39 +02:00
|
|
|
add_custom_target(doc ALL
|
2012-02-13 10:42:26 +01:00
|
|
|
${DOXYGEN_EXECUTABLE} ${CMAKE_BINARY_DIR}/doc/Doxyfile-html.dox)
|
2011-10-06 10:41:49 +02:00
|
|
|
|
2012-08-30 19:20:03 +02:00
|
|
|
else()
|
2011-10-06 10:41:49 +02:00
|
|
|
|
2012-08-30 19:14:39 +02:00
|
|
|
message(STATUS "Doxygen not found, we cannot generate the documentation")
|
2011-10-06 10:41:49 +02:00
|
|
|
|
2012-08-30 19:20:03 +02:00
|
|
|
endif()
|