Index: docs/CMakeLists.txt =================================================================== --- docs/CMakeLists.txt +++ docs/CMakeLists.txt @@ -21,6 +21,22 @@ set(enable_external_search "NO") set(extra_search_mappings "") endif() + + #------------------------------------------------------- + # This lets you create a QHP and QCH documentation file + #------------------------------------------------------- + # Initialize defaults: + set(generate_qhp "NO") + set(CLANG_DOC_QCH_FILENAME "org.llvm.clang.qch" CACHE STRING "Name of the QCH documentation file (has no effect unless CLANG_GENERATE_QCH is ON)") + set(CLANG_DOC_QHP_NAMESPACE "org.llvm.clang" CACHE STRING "Namespace under which to find the documentation (has no effect unless CLANG_GENERATE_QCH is ON)" ) + option(CLANG_DOC_GENERATE_QHP "Generate a QHP documentation file" OFF) + if (CLANG_DOC_GENERATE_QHP) + option(CLANG_DOC_GENERATE_QCH "Generate a QCH documentation file for inclusion in Qt Creator (has no effect unless CLANG_GENERATE_QHP is ON)" OFF) + set(generate_qhp "YES") + if (CLANG_DOC_GENERATE_QCH) + find_program(CLANG_DOC_QHELPGENERATOR_PATH qhelpgenerator DOC "Path to the qhelpgenerator binary") + endif() + endif() configure_file(${CMAKE_CURRENT_SOURCE_DIR}/doxygen.cfg.in ${CMAKE_CURRENT_BINARY_DIR}/doxygen.cfg @ONLY) Index: docs/doxygen.cfg.in =================================================================== --- docs/doxygen.cfg.in +++ docs/doxygen.cfg.in @@ -697,6 +697,68 @@ TOC_EXPAND = NO +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated +# that can be used as input for Qt's qhelpgenerator to generate a +# Qt Compressed Help (.qch) of the generated HTML documentation. + +GENERATE_QHP = @generate_qhp@ + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can +# be used to specify the file name of the resulting .qch file. +# The path specified is relative to the HTML output folder. + +QCH_FILE = @CLANG_DOC_QCH_FILENAME@ + +# The QHP_NAMESPACE tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see +# http://doc.trolltech.com/qthelpproject.html#namespace + +QHP_NAMESPACE = @CLANG_DOC_QHP_NAMESPACE@ + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see +# http://doc.trolltech.com/qthelpproject.html#virtual-folders + +QHP_VIRTUAL_FOLDER = doc + +# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to +# add. For more information please see +# http://doc.trolltech.com/qthelpproject.html#custom-filters + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see +# +# Qt Help Project / Custom Filters. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's +# filter section matches. +# +# Qt Help Project / Filter Attributes. + +QHP_SECT_FILTER_ATTRS = + +# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can +# be used to specify the location of Qt's qhelpgenerator. +# If non-empty doxygen will try to run qhelpgenerator on the generated +# .qhp file. + +QHG_LOCATION = @CLANG_DOC_QHELPGENERATOR_PATH@ + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files +# will be generated, which together with the HTML files, form an Eclipse help +# plugin. To install this plugin and make it available under the help contents +# menu in Eclipse, the contents of the directory containing the HTML and XML +# files needs to be copied into the plugins directory of eclipse. The name of +# the directory within the plugins directory should be the same as +# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before +# the help appears. + # The DISABLE_INDEX tag can be used to turn on/off the condensed index at # top of each HTML page. The value NO (the default) enables the index and # the value YES disables it.