Страницы контроля качества

qdoc может генерировать дополнительные HTML-страницы, которые могут быть полезны для отладки документации qdoc. Эти страницы QA облегчают поиск ссылок, которые ведут не по адресу или вообще никуда не ведут, тем, кто пишет документацию.

Генерация страниц контроля качества

Добавьте -write-qa-pages в командную строку, чтобы указать qdoc на генерацию страниц контроля качества. Если этот параметр не указан, страницы контроля качества не будут сгенерированы, а ранее сгенерированные страницы контроля качества будут удалены.

Поиск главной страницы контроля качества модуля

Главная страница контроля качества модуля не связана с сгенерированной документацией модуля, но она находится в той же выходной директории. Чтобы найти главную страницу контроля качества модуля xxx, перейдите в выходную директорию qdoc для модуля xxx в своём браузере. Вверху списка отображаются несколько файлов, имена которых начинаются с aaa. Это страницы контроля качества модуля xxx. Имена файлов начинаются с aaa, чтобы они легко находились вверху каталога.

Для модуля xxx найдите файл aaa-xxx-qa-page.html. Это главная страница контроля качества модуля xxx. Загрузите этот файл в браузер. На главной странице контроля качества отображается таблица, содержащая ссылки на несколько страниц контроля качества подмодулей.

Например, главной страницей контроля качества для QtCore является aaa-qtcore-qa-page.html. Это была таблица для QtCore на определённом этапе:

Каждая запись таблицы показывает количество ссылок из QtCore в другой модуль, за исключением последней записи, которая показывает количество нерабочих ссылок в QtCore. Щёлкните по записи qtquick, чтобы загрузить страницу контроля качества подмодуля, отображающую ссылки из QtCore в QtQuick.

Страница ссылок на ссылки

Нажатие на запись таблицы qtquick на главной странице контроля качества для QtCore загружает страницу контроля качества подмодуля, отображающую таблицу, содержащую все ссылки из QtCore в QtQuick. Таблица содержит все ссылки, созданные с помощью команды \l, а также автоматические ссылки.

На момент генерации этой таблицы было шесть ссылок из QtCore в QtQuick. Первый столбец каждой записи таблицы содержит ссылку на некоторую ссылку в QtCore. Текст ссылки, как он отображается в QtCore, показан. Второй и третий столбцы содержат имя файла исходного кода и номер строки, где qdoc обнаружил ссылку в комментарии qdoc.

Примечание: Номер строки обычно относится к первой строке комментария, где qdoc обнаружил ссылку.

Нажатие на ссылку в таблице переводит вас на эту ссылку в документации. Там ссылка будет помечена тремя красными звёздочками. Например, нажатие на ссылку в пятой записи таблицы переведёт вас сюда:

Ссылка помечена тремя красными звёздочками. Теперь вы можете нажать на фактическую ссылку, чтобы проверить, ведёт ли она в нужное место. В этом случае ссылка должна вести на страницу справки класса QQuickItem. Вы можете проверить каждую ссылку в таблице таким образом. Если вы найдёте ссылку, которая ведёт не по адресу, используйте имя файла исходного кода и номер строки, чтобы найти ссылку, и исправьте проблему, используя квадратные скобки для команды \l.