Установка Clang для QDoc

QDoc использует Clang при разборе файлов C++ а также сигнатур функций в командах \fn. Clang является частью проекта LLVM Compiler Infrastructure Project. Поэтому, если вы собираетесь скомпилировать QDoc из исходного кода, необходимо сначала установить LLVM 6.0 или более позднюю версию. Требуемые предварительно скомпилированные бинарные файлы можно найти здесь.

Для компиляции QDoc на дистрибутивах Linux на основе Debian достаточно установить пакет libclang-dev и его зависимости. Для запуска QDoc необходим пакет libclang.

Примечание: В Windows после установки предварительно скомпилированного LLVM необходимо перезапустить командную оболочку, чтобы убедиться, что каталоги библиотек LLVM добавлены в переменную среды PATH. Это необходимо для запуска qdoc.

Автоматическое определение расположения Clang

Система сборки Qt использует инструмент llvm-config для определения расположения LLVM в вашей системе и полагается на путь к llvm-config, который должен быть указан в переменной среды PATH. llvm-config обычно устанавливается вместе с LLVM и Clang на системах Linux, а также на macOS, если LLVM установлен с помощью Brew.

В Windows предоставляемые LLVM бинарные файлы не включают llvm-config. Вы все равно можете иметь его на своей системе, если вы сами скомпилировали LLVM из исходного кода. Если это так, и вы хотите, чтобы система сборки автоматически определила Clang, добавьте путь к llvm-config в переменную среды PATH. Например:

C:\> set PATH=%PATH%;C:\[build directory]\bin\Release"

Убедитесь, что вы задали путь к каталогу вашей сборки LLVM. Исполняемый файл llvm-config расположен в bin\Release или bin\Debug, отражая версию сборки.

Ручное указание расположения Clang

Если llvm-config не находится в переменной среды PATH или не установлен на вашей системе, вы все еще можете скомпилировать QDoc, вручную установив переменную среды LLVM_INSTALL_DIR, указывающую на каталог, где установлены библиотеки Clang. Этот каталог должен быть каталогом верхнего уровня. Например, на системе Linux или macOS с установленным LLVM в /usr/llvm:

$ export LLVM_INSTALL_DIR=/usr/llvm

Дистрибутивы Linux на основе Debian обычно предлагают несколько версий пакетов libclang, таких как libclang-<VERSION>. В этом случае LLVM_INSTALL_DIR должен содержать /usr/lib/clang/<VERSION>.

На системе Windows с установленным LLVM в C:\Program Files\LLVM:

C:\> set LLVM_INSTALL_DIR=C:\Program Files\LLVM