Jump to content

QDoc Linking Guidelines

From Qt Wiki
Revision as of 14:22, 14 October 2024 by Jerome Pasion (talk | contribs) (Remove content already covered in QDoc manual: https://doc.qt.io/qt-6/qdoc-index.html)

This page is part of the Qt Writing Guidelines

This page contains information about creating links to API pages and other articles and content.

Enabling Linking to Content Outside a Module

To link to a section, API, or page outside of the documentation project (content not included in the .qdocconf file), the module name must be set to the depends qdocconf variable.

depends += qtcore qtqml qtgui qtlinguist

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