Building Qt Documentation/ru

Русский English Italiano Spanish 日本語 简体中文

Построение документации Qt

Для информации о написании документации для Qt, смотрите страницу Writing Qt Documentation.

Сборка qdoc3

qdoc3 собирается в процессе нормальной компиляции Qt, так как он необходим для создания документации Qt. Соответственно, обычно нет необходимости собирать его отдельно, он идет в комплекте с остальными утилитами Qt.

Было бы хорошо, если бы можно было построить минимально возможный набор Qt библиотек, требуемых для qdoc3 с помощью простого правила. Однако, сейчас необходимо задействовать несколько правил для получения необходимых библиотек для построения qdoc3. В корневой директории вызовите следующие правила.

Linux/Unix:

make sub-tools-bootstrap sub-moc sub-corelib sub-xml sub-qdoc3

Windows:

nmake sub-tools-bootstrap sub-moc sub-corelib sub-xml sub-qdoc3

Запуск qdoc3

Есть два пути для построения документации по Qt.

Использование готового makefile Qt

В командной строке, перейдите в корневую директорию и вызовите docs правило.

Например, на Linux/Unix платформе:

cd path/to/qt-build
make docs

В Windows можете использовать nmake для VS компилятора или make для MinGW:

cd path\to\qt-build
nmake docs

Запуск qdoc3 явно

Если вы уже имеете собранный qdoc3, можете вызвать непосредственно qdoc3 для построения документации.

В командной строке, установите QTDIR и QT_SOURCE_TREE переменные окружения. Затем перейдите в корневую директорию и запустите qdoc3.

Например, для Linux/Unix платформы:

cd path/to/qt-build
bin/qdoc3 tools/qdoc3/test/qt.qdocconf