Введение в QDoc

QDoc — это инструмент, используемый разработчиками Qt для генерации документации для программных проектов. Он работает, извлекая комментарии QDoc из исходных файлов проекта и затем форматируя эти комментарии в виде HTML-страниц или документов DITA XML. QDoc находит комментарии QDoc в .cpp файлах и в .qdoc файлах. QDoc не ищет комментарии QDoc в .h файлах. Комментарий QDoc всегда начинается с восклицательного знака (!)). Например:

    / *!
        \class QObject
        \brief The QObject class is the base class of all Qt objects.

        \ingroup objectmodel

        \reentrant

        QObject is the heart of the Qt \l{Object Model}. The
        central feature in this model is a very powerful mechanism
        for seamless object communication called \l{signals and
        slots}. You can connect a signal to a slot with connect()
        and destroy the connection with disconnect(). To avoid
        never ending notification loops you can temporarily block
        signals with blockSignals(). The protected functions
        connectNotify() and disconnectNotify() make it possible to
        track connections.

        QObjects organize themselves in \l {Object Trees &
        Ownership} {object trees}. When you create a QObject with
        another object as parent, the object will automatically
        add itself to the parent's \c children() list. The parent
        takes ownership of the object. It will automatically
        delete its children in its destructor. You can look for an
        object by name and optionally type using findChild() or
        findChildren().

        Every object has an objectName() and its class name can be
        found via the corresponding metaObject() (see
        QMetaObject::className()). You can determine whether the
        object's class inherits another class in the QObject
        inheritance hierarchy by using the \c inherits() function.

    ....
* /

Из комментария QDoc выше QDoc генерирует страницу справки класса QObject.

В данном руководстве объясняется, как использовать команды QDoc в комментариях QDoc для встраивания хорошей документации в ваши исходные файлы. Также объясняется, как создать файл конфигурации QDoc, который вы передадите QDoc в командной строке.

Запуск QDoc

Имя программы QDoc — qdoc. Чтобы запустить qdoc из командной строки, укажите имя файла конфигурации:

$ ../../bin/qdoc ./config.qdocconf

QDoc распознаёт суффикс .qdocconf как файл конфигурации QDoc. В файле конфигурации вы указываете QDoc, где найти исходные файлы проекта, заголовочные файлы и .qdoc файлы. Также в нём вы указываете QDoc, какой тип выходных данных генерировать (HTML, DITA XML...) и куда поместить сгенерированную документацию. Файл конфигурации также содержит другую информацию для QDoc.

См. Файл конфигурации QDoc для инструкций по настройке файла конфигурации QDoc.

Запуск QDoc в режиме единого выполнения

Начиная с Qt 5.5, доступен новый способ запуска QDoc, который сокращает время генерации документации Qt5 на 90%. Новый способ запуска QDoc — режим единого выполнения. Режим единого выполнения в настоящее время недоступен в системе сборки Qt5, которая по-прежнему использует стандартный режим. Режим единого выполнения доступен только при самостоятельном запуске QDoc, что вам часто потребуется при документировании модуля и интеграции вашей документации с другими модулями Qt.

Чтобы запустить QDoc в режиме единого выполнения, добавьте -single-exec в командную строку и передайте QDoc главный qdocconf файл, который представляет собой просто список путей к файлам qdocconf всех модулей Qt5. Например:

/Users/me/qt5/qtbase/bin/qdoc -outputdir /Users/me/qt5/qtbase/doc -installdir /Users/me/qt5/qtbase/doc /Users/me/qt5/master.qdocconf -single-exec

Файл qdocconf, master.qdocconf, просто перечисляет файлы qdocconf для всех модулей Qt5, которые нужно обработать:

/Users/me/qt5/qtbase/src/corelib/doc/qtcore.qdocconf
/Users/me/qt5/qtbase/src/network/doc/qtnetwork.qdocconf
/Users/me/qt5/qtbase/src/sql/doc/qtsql.qdocconf
/Users/me/qt5/qtbase/src/xml/doc/qtxml.qdocconf
/Users/me/qt5/qtbase/src/testlib/doc/qttestlib.qdocconf
/Users/me/qt5/qtbase/src/concurrent/doc/qtconcurrent.qdocconf
/Users/me/qt5/qtbase/src/gui/doc/qtgui.qdocconf
/Users/me/qt5/qtbase/src/platformheaders/doc/qtplatformheaders.qdocconf
/Users/me/qt5/qtbase/src/widgets/doc/qtwidgets.qdocconf
/Users/me/qt5/qtbase/src/opengl/doc/qtopengl.qdocconf
/Users/me/qt5/qtbase/src/printsupport/doc/qtprintsupport.qdocconf
/Users/me/qt5/qtbase/src/tools/qdoc/doc/config/qdoc.qdocconf
/Users/me/qt5/qtbase/qmake/doc/qmake.qdocconf
/Users/me/qt5/qtsvg/src/svg/doc/qtsvg.qdocconf
/Users/me/qt5/qtxmlpatterns/src/xmlpatterns/doc/qtxmlpatterns.qdocconf
/Users/me/qt5/qtdeclarative/src/qml/doc/qtqml.qdocconf
/Users/me/qt5/qtdeclarative/src/quick/doc/qtquick.qdocconf
/Users/me/qt5/qtquickcontrols/src/controls/doc/qtquickcontrols.qdocconf
/Users/me/qt5/qtquickcontrols/src/layouts/doc/qtquicklayouts.qdocconf
/Users/me/qt5/qtquickcontrols/src/dialogs/doc/qtquickdialogs.qdocconf
/Users/me/qt5/qtmultimedia/src/multimedia/doc/qtmultimedia.qdocconf
/Users/me/qt5/qtmultimedia/src/multimediawidgets/doc/qtmultimediawidgets.qdocconf
/Users/me/qt5/qtactiveqt/src/activeqt/doc/activeqt.qdocconf
/Users/me/qt5/qtsensors/src/sensors/doc/qtsensors.qdocconf
/Users/me/qt5/qtwebkit/Source/qtwebkit.qdocconf
/Users/me/qt5/qttools/src/assistant/help/doc/qthelp.qdocconf
/Users/me/qt5/qttools/src/assistant/assistant/doc/qtassistant.qdocconf
/Users/me/qt5/qttools/src/designer/src/uitools/doc/qtuitools.qdocconf
/Users/me/qt5/qttools/src/designer/src/designer/doc/qtdesigner.qdocconf
/Users/me/qt5/qttools/src/linguist/linguist/doc/qtlinguist.qdocconf
/Users/me/qt5/qtwebkit-examples/doc/qtwebkitexamples.qdocconf
/Users/me/qt5/qtimageformats/src/imageformats/doc/qtimageformats.qdocconf
/Users/me/qt5/qtgraphicaleffects/src/effects/doc/qtgraphicaleffects.qdocconf
/Users/me/qt5/qtscript/src/script/doc/qtscript.qdocconf
/Users/me/qt5/qtscript/src/scripttools/doc/qtscripttools.qdocconf
/Users/me/qt5/qtserialport/src/serialport/doc/qtserialport.qdocconf
/Users/me/qt5/qtdoc/doc/config/qtdoc.qdocconf

Почему стандартный режим медленный

В настоящее время система сборки Qt5 не использует режим единого выполнения QDoc для генерации документации Qt5. Она запускает QDoc в стандартном режиме. Стандартный режим возник, потому что это был самый простой способ адаптировать Qt4 QDoc к модульной структуре Qt в Qt5. В Qt4 QDoc выполнялся один раз для всех исходных кодов Qt4, чтобы сгенерировать HTML-документацию для Qt. Во время генерации документации Qt Qt4 QDoc также генерировал индексный файл для Qt. Этот индексный файл предназначался для использования в последующих запусках QDoc для генерации HTML-документации для других программных библиотек/продуктов, основанных на Qt. Файл индекса Qt позволил QDoc связывать документацию, написанную для этих других библиотек/продуктов, с документацией Qt4.

Когда появился Qt5, Qt был разделен на модули. С тех пор к Qt добавлено множество новых модулей. По состоянию на версию 5.5 в Qt5 более 40 отдельных модулей, каждый со своей документацией, которая ссылается на (зависит от) документации других модулей Qt.

В стандартном режиме QDoc выполняется дважды для каждого модуля. Первый запуск QDoc для конкретного модуля Qt анализирует все исходные файлы модуля, а затем использует полученную информацию для генерации индексного файла модуля. Он называется фазой подготовки, потому что подготавливает индексный файл модуля. Второй запуск QDoc для модуля также анализирует все исходные файлы модуля и генерирует страницы документации модуля. Это называется фазой генерации, потому что она генерирует документацию модуля.

Документация модуля, скорее всего, будет содержать HTML-ссылки на документацию одного или нескольких других модулей Qt. Например, большинство модулей Qt5 содержат ссылки на документацию в QtCore. Когда модуль Qt содержит ссылки на документацию другого модуля Qt, этот модуль зависит от этих других модулей Qt. Следовательно, когда QDoc выполняет фазу генерации для этого модуля, он также должен загрузить индексные файлы этих модулей, чтобы он мог создать эти ссылки.

Таким образом, когда система сборки Qt генерирует документацию Qt, она сначала выполняет QDoc один раз для каждого модуля, чтобы выполнить фазу подготовки, для генерации всех индексных файлов. Затем она выполняет QDoc один раз для каждого модуля, чтобы выполнить фазу генерации, где использует зависимые индексные файлы для генерации документации модуля, включая любые межмодульные ссылки, которые она находит. Каждое выполнение QDoc, как фаза подготовки, так и фаза генерации, анализирует все исходные файлы, включенные в модуль, а в фазе генерации также анализирует индексные файлы зависимых модулей. Ничто не сохраняется или не сохраняемо между запусками QDoc.

Почему режим единого выполнения значительно быстрее

Как следует из названия, режим единого выполнения использует один процесс QDoc для генерации всей документации Qt5. Единственный процесс QDoc по-прежнему выполняет фазу подготовки для каждого модуля, а затем фазу генерации для каждого модуля, но есть несколько различий. Он начинает с чтения файла master qdocconf. Затем он читает каждый файл qdocconf в главном списке и выполняет фазу подготовки для каждого модуля. Во время фазы подготовки все исходные файлы модуля анализируются для построения синтаксического дерева модуля. Индексный файл модуля затем генерируется, хотя QDoc не будет повторно читать индексные файлы в фазе генерации. Важное различие заключается в том, что синтаксическое дерево модуля сохраняется после генерации индексного файла, так что после завершения фазы подготовки для всех модулей QDoc всё ещё имеет все построенные синтаксические деревья.

Затем QDoc повторно обрабатывает каждый модуль для фазы генерации. Но теперь QDoc не нуждается в повторном анализе исходных файлов каждого модуля, потому что синтаксическое дерево модуля всё ещё находится в памяти. QDoc также не нуждается в повторном чтении индексных файлов зависимых модулей, опять же, потому что всё ещё имеет синтаксические деревья этих модулей в памяти. Осталось только пройтись по синтаксическому дереву каждого модуля, чтобы сгенерировать страницы документации.

Таким образом, QDoc анализирует каждый исходный файл один раз и только один раз и не нуждается в чтении индексных файлов. Именно это делает режим единого выполнения значительно быстрее, чем стандартный режим. Предполагается, что система сборки Qt в конечном итоге будет запускать QDoc в режиме единого выполнения. Однако могут потребоваться изменения в файле master qdocconf, поэтому описанный выше метод запуска QDoc в режиме единого выполнения может потребовать изменения. Следите за обновлениями.

Как работает QDoc

QDoc начинает с чтения файла конфигурации, который вы указали в командной строке. Он сохраняет все переменные из файла конфигурации для последующего использования. Одна из первых переменных, которую он использует, — outputformats. Эта переменная указывает QDoc, какие генераторы выходных данных он будет запускать. Значение по умолчанию — HTML, поэтому если вы не установите outputformats в своём файле конфигурации, QDoc сгенерирует выходные данные HTML. Это обычно то, что вам нужно, но вы также можете указать DITAXML, чтобы получить выходные данные DITA XML вместо этого.

Далее QDoc использует значения переменных headerdirs и/или headers, чтобы найти и проанализировать все заголовочные файлы вашего проекта. QDoc не сканирует заголовочные файлы на предмет комментариев QDoc. Он анализирует заголовочные файлы, чтобы построить главное дерево всех элементов, которые должны быть задокументированы, другими словами, элементов, для которых QDoc должен найти комментарии QDoc.

После анализа всех заголовочных файлов и построения главного дерева элементов, которые нужно задокументировать, QDoc использует значение переменной sourcedirs и/или значение переменной sources, чтобы найти и проанализировать все .cpp и .qdoc файлы вашего проекта. Это те файлы, которые QDoc сканирует на предмет комментариев QDoc. Помните, что комментарий QDoc начинается с восклицательного знака: /*! .

Для каждого найденного комментария QDoc ищет в главном дереве элемент, которому принадлежит документация. Затем он интерпретирует команды qdoc в комментарии и сохраняет интерпретированные команды и текст комментария в узле дерева для элемента.

Наконец, QDoc проходит по главному дереву. Для каждого узла, если в узле хранится документация, QDoc вызывает генератор выходных данных, указанный переменной outputformats, чтобы отформатировать и записать документацию в каталог, указанный в файле конфигурации в переменной outputdir.

Типы команд

QDoc интерпретирует три типа команд:

• Команды тем
• Команды контекста
• Команды форматирования

Команды темы идентифицируют элемент, который вы документируете, например, класс C++, функцию, тип или дополнительную страницу текста, которая не соответствует подлежащему элементу C++.

Команды контекста сообщают QDoc, как элемент, который документируется, относится к другим задокументированным элементам, например, к ссылкам на следующую и предыдущую страницы, включению в группы страниц или модули библиотек. Команды контекста также могут предоставлять информацию об элементе, который документируется, которую QDoc не может получить из исходных файлов, например, является ли элемент потокобезопасным, является ли это перегруженной или переопределенной функцией или она устарела.

Команды форматирования сообщают QDoc, как текст и элементы изображений в документе должны быть отображены, или о структуре документа.