diff options
author | Michael Gottesman <mgottesman@apple.com> | 2014-03-07 19:19:28 +0000 |
---|---|---|
committer | Michael Gottesman <mgottesman@apple.com> | 2014-03-07 19:19:28 +0000 |
commit | fac248734708670e898b814f88f5f262da774de3 (patch) | |
tree | 1a1dae57794663ba90074797f4f15ccef450eba2 /docs/CMake.rst | |
parent | 3bfc4d8e13edd83534b733f0f1de5b1d5f6bf828 (diff) | |
download | llvm-fac248734708670e898b814f88f5f262da774de3.tar.gz llvm-fac248734708670e898b814f88f5f262da774de3.tar.bz2 llvm-fac248734708670e898b814f88f5f262da774de3.tar.xz |
[docs] Teach CMake docs build how to generate Qt Creator help/documentation files.
Patch by Konrad Kleine.
Differential Revision: http://llvm-reviews.chandlerc.com/D2967
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@203272 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs/CMake.rst')
-rw-r--r-- | docs/CMake.rst | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/docs/CMake.rst b/docs/CMake.rst index 49279d5ede..cbca1dbeb5 100644 --- a/docs/CMake.rst +++ b/docs/CMake.rst @@ -283,6 +283,50 @@ LLVM-specific variables are ``Address``, ``Memory`` and ``MemoryWithOrigins``. Defaults to empty string. +**LLVM_ENABLE_DOXYGEN**:BOOL + Enables the generation of browsable HTML documentation using doxygen. + Defaults to OFF. + +**LLVM_ENABLE_DOXYGEN_QT_HELP**:BOOL + Enables the generation of a Qt Compressed Help file. Defaults to OFF. + This affects the make target ``doxygen-llvm``. When enabled, apart from + the normal HTML output generated by doxygen, this will produce a QCH file + named ``org.llvm.qch``. You can then load this file into Qt Creator. + This option is only useful in combination with ``-DLLVM_ENABLE_DOXYGEN=ON``; + otherwise this has no effect. + +**LLVM_DOXYGEN_QCH_FILENAME**:STRING + The filename of the Qt Compressed Help file that will be genrated when + ``-DLLVM_ENABLE_DOXYGEN=ON`` and + ``-DLLVM_ENABLE_DOXYGEN_QT_HELP=ON`` are given. Defaults to + ``org.llvm.qch``. + This option is only useful in combination with + ``-DLLVM_ENABLE_DOXYGEN_QT_HELP=ON``; + otherwise this has no effect. + +**LLVM_DOXYGEN_QHP_NAMESPACE**:STRING + Namespace under which the intermediate Qt Help Project file lives. See `Qt + Help Project <http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace>`_ + for more information. Defaults to "org.llvm". This option is only useful in + combination with ``-DLLVM_ENABLE_DOXYGEN_QT_HELP=ON``; otherwise + this has no effect. + +**LLVM_DOXYGEN_QHP_CUST_FILTER_NAME**:STRING + See `Qt Help Project + <http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-filters>`_ for + more information. Defaults to the CMake variable ``${PACKAGE_STRING}`` which + is a combination of the package name and version string. This filter can then + be used in Qt Creator to select only documentation from LLVM when browsing + through all the help files that you might have loaded. This option is only + useful in combination with ``-DLLVM_ENABLE_DOXYGEN_QT_HELP=ON``; + otherwise this has no effect. + +**LLVM_DOXYGEN_QHELPGENERATOR_PATH**:STRING + The path to the ``qhelpgenerator`` executable. Defaults to whatever CMake's + ``find_program()`` can find. This option is only useful in combination with + ``-DLLVM_ENABLE_DOXYGEN_QT_HELP=ON``; otherwise this has no + effect. + Executing the test suite ======================== |