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

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

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

Автоматическая установка расположения 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