QDoc Linking Guidelines

This page is part of the Qt Writing Guidelines

QDoc allows linking to C++ API, QML API, other QDoc projects, and external sites. The QDoc Manual has a linking guide.

• QDoc Manual
• Creating Links

Linking to QDoc projects or Qt modules

To link to other QDoc projects, set the directory name to the depends variable of your project's .qdocconf file.

For example, to link to Qt Core, Qt QML, Qt GUI, and Qt Linguist pages such as API and examples, set the depends variable with the directory name:

depends += qtcore qtqml qtgui qtlinguist

The depends entry corresponds to the directories found in the QT_INSTALL_DOCS directory.

For more information about linking to Qt documentation, visit the following pages from the QDoc Manual:

• depends variable
• Creating QDoc Configuration Files
• Supporting Derived Projects