cmake/modules/Doxygen.cmake

0001 # generate documentation on 'make doxygen-doc'
0002 file(MAKE_DIRECTORY ${CMAKE_BINARY_DIR}/doc)
0003
0004 find_package(Doxygen)
0005 if(DOXYGEN_FOUND)
0006     find_program(QHELPGENERATOR_EXECUTABLE qhelpgenerator)
0007     mark_as_advanced(QHELPGENERATOR_EXECUTABLE)
0008
0009     include(FindPackageHandleStandardArgs)
0010     find_package_handle_standard_args(QHELPGENERATOR DEFAULT_MSG QHELPGENERATOR_EXECUTABLE)
0011
0012     set(QT_TAGS_FILE     ${QT_DOC_DIR}/html/qt.tags)
0013     if(EXISTS ${QT_TAGS_FILE})
0014         find_package(Perl)
0015
0016         if (NOT PERL_FOUND)
0017             message(WARNING "Perl was not found. Qt crosslinks in uploaded docs won't be valid.")
0018         endif (NOT PERL_FOUND)
0019     else(EXISTS ${QT_TAGS_FILE})
0020         message(WARNING "html/qt.tags not found in ${QT_DOC_DIR}. Set the QT_DOC_DIR variable to
0021 point to its location to enable crosslinking.")
0022         unset(QT_TAGS_FILE)
0023     endif(EXISTS ${QT_TAGS_FILE})
0024
0025     set(abs_top_builddir ${CMAKE_BINARY_DIR})
0026     set(abs_top_srcdir   ${CMAKE_SOURCE_DIR})
0027     set(GENERATE_HTML    YES)
0028     set(GENERATE_RTF     NO)
0029     set(GENERATE_CHM     NO)
0030     set(GENERATE_CHI     NO)
0031     set(GENERATE_LATEX   NO)
0032     set(GENERATE_MAN     NO)
0033     set(GENERATE_XML     NO)
0034     set(GENERATE_QHP     ${QHELPGENERATOR_FOUND})
0035     configure_file(doxygen.cfg.in ${CMAKE_BINARY_DIR}/doxygen.cfg)
0036     add_custom_target(doxygen-doc ${DOXYGEN_EXECUTABLE} ${CMAKE_BINARY_DIR}/doxygen.cfg)
0037 endif(DOXYGEN_FOUND)