Установка 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