1berry/qtbase
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Doc: Enable automatic linking to sources on code.qt.io

Browse Source 
Since 6.10, QDoc is capable of generating links to the declaration in
the source code for each documented C++ API entity in their `Detailed
description`.

Add the required configuration to enable this feature in online
documentation builds.

Change-Id: Iaafabc5aea50a6cd72549bb1c04007bb4de498ca
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
This commit is contained in:
Topi Reinio 2025-05-14 10:43:27 +00:00
parent 2c6d729be9
commit cc07564978
36 changed files with 108 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/config/exampleurl-qt3d.qdocconf
View File

@ -1 +1,4 @@
url.examples = "https://code.qt.io/cgit/qt/qt3d.git/tree/examples/\1?h=$QT_VER"
# Automatic linking to declarations of C++ APIs
url.sources = "https://code.qt.io/cgit/qt/qt3d.git/tree/\1?h=$QT_VER#n\2"

3
doc/config/exampleurl-qtactiveqt.qdocconf
View File

@ -1 +1,4 @@
url.examples = "https://code.qt.io/cgit/qt/qtactiveqt.git/tree/examples/\1?h=$QT_VER"
# Automatic linking to declarations of C++ APIs
url.sources = "https://code.qt.io/cgit/qt/qtactiveqt.git/tree/\1?h=$QT_VER#n\2"

3
doc/config/exampleurl-qtbase.qdocconf
View File

@ -1 +1,4 @@
url.examples = "https://code.qt.io/cgit/qt/qtbase.git/tree/examples/\1?h=$QT_VER"
# Automatic linking to declarations of C++ APIs
url.sources = "https://code.qt.io/cgit/qt/qtbase.git/tree/\1?h=$QT_VER#n\2"

3
doc/config/exampleurl-qtconnectivity.qdocconf
View File

@ -1 +1,4 @@
url.examples = "https://code.qt.io/cgit/qt/qtconnectivity.git/tree/examples/\1?h=$QT_VER"
# Automatic linking to declarations of C++ APIs
url.sources = "https://code.qt.io/cgit/qt/qtconnectivity.git/tree/\1?h=$QT_VER#n\2"

3
doc/config/exampleurl-qtdatavis3d.qdocconf
View File

@ -1 +1,4 @@
url.examples = "https://code.qt.io/cgit/qt/qtdatavis3d.git/tree/examples/\1?h=$QT_VER"
# Automatic linking to declarations of C++ APIs
url.sources = "https://code.qt.io/cgit/qt/qtdatavis3d.git/tree/\1?h=$QT_VER#n\2"

3
doc/config/exampleurl-qtdeclarative.qdocconf
View File

@ -1 +1,4 @@
url.examples = "https://code.qt.io/cgit/qt/qtdeclarative.git/tree/examples/\1?h=$QT_VER"
# Automatic linking to declarations of C++ APIs
url.sources = "https://code.qt.io/cgit/qt/qtdeclarative.git/tree/\1?h=$QT_VER#n\2"

3
doc/config/exampleurl-qtlocation.qdocconf
View File

@ -1 +1,4 @@
url.examples = "https://code.qt.io/cgit/qt/qtlocation.git/tree/examples/\1?h=$QT_VER"
# Automatic linking to declarations of C++ APIs
url.sources = "https://code.qt.io/cgit/qt/qtlocation.git/tree/\1?h=$QT_VER#n\2"

3
doc/config/exampleurl-qtmultimedia.qdocconf
View File

@ -1 +1,4 @@
url.examples = "https://code.qt.io/cgit/qt/qtmultimedia.git/tree/examples/\1?h=$QT_VER"
# Automatic linking to declarations of C++ APIs
url.sources = "https://code.qt.io/cgit/qt/qtmultimedia.git/tree/\1?h=$QT_VER#n\2"

3
doc/config/exampleurl-qtnetworkauth.qdocconf
View File

@ -1 +1,4 @@
url.examples = "https://code.qt.io/cgit/qt/qtnetworkauth.git/tree/examples/\1?h=$QT_VER"
# Automatic linking to declarations of C++ APIs
url.sources = "https://code.qt.io/cgit/qt/qtnetworkauth.git/tree/\1?h=$QT_VER#n\2"

3
doc/config/exampleurl-qtpositioning.qdocconf
View File

@ -1 +1,4 @@
url.examples = "https://code.qt.io/cgit/qt/qtpositioning.git/tree/examples/\1?h=$QT_VER"
# Automatic linking to declarations of C++ APIs
url.sources = "https://code.qt.io/cgit/qt/qtpositioning.git/tree/\1?h=$QT_VER#n\2"

3
doc/config/exampleurl-qtremoteobjects.qdocconf
View File

@ -1 +1,4 @@
url.examples = "https://code.qt.io/cgit/qt/qtremoteobjects.git/tree/examples/\1?h=$QT_VER"
# Automatic linking to declarations of C++ APIs
url.sources = "https://code.qt.io/cgit/qt/qtremoteobjects.git/tree/\1?h=$QT_VER#n\2"

3
doc/config/exampleurl-qtscxml.qdocconf
View File

@ -1 +1,4 @@
url.examples = "https://code.qt.io/cgit/qt/qtscxml.git/tree/examples/\1?h=$QT_VER"
# Automatic linking to declarations of C++ APIs
url.sources = "https://code.qt.io/cgit/qt/qtscxml.git/tree/\1?h=$QT_VER#n\2"

3
doc/config/exampleurl-qtsensors.qdocconf
View File

@ -1 +1,4 @@
url.examples = "https://code.qt.io/cgit/qt/qtsensors.git/tree/examples/\1?h=$QT_VER"
# Automatic linking to declarations of C++ APIs
url.sources = "https://code.qt.io/cgit/qt/qtsensors.git/tree/\1?h=$QT_VER#n\2"

3
doc/config/exampleurl-qtserialbus.qdocconf
View File

@ -1 +1,4 @@
url.examples = "https://code.qt.io/cgit/qt/qtserialbus.git/tree/examples/\1?h=$QT_VER"
# Automatic linking to declarations of C++ APIs
url.sources = "https://code.qt.io/cgit/qt/qtserialbus.git/tree/\1?h=$QT_VER#n\2"

3
doc/config/exampleurl-qtserialport.qdocconf
View File

@ -1 +1,4 @@
url.examples = "https://code.qt.io/cgit/qt/qtserialport.git/tree/examples/\1?h=$QT_VER"
# Automatic linking to declarations of C++ APIs
url.sources = "https://code.qt.io/cgit/qt/qtserialport.git/tree/\1?h=$QT_VER#n\2"

3
doc/config/exampleurl-qtspeech.qdocconf
View File

@ -1 +1,4 @@
url.examples = "https://code.qt.io/cgit/qt/qtspeech.git/tree/examples/\1?h=$QT_VER"
# Automatic linking to declarations of C++ APIs
url.sources = "https://code.qt.io/cgit/qt/qtspeech.git/tree/\1?h=$QT_VER#n\2"

3
doc/config/exampleurl-qtsvg.qdocconf
View File

@ -1 +1,4 @@
url.examples = "https://code.qt.io/cgit/qt/qtsvg.git/tree/examples/\1?h=$QT_VER"
# Automatic linking to declarations of C++ APIs
url.sources = "https://code.qt.io/cgit/qt/qtsvg.git/tree/\1?h=$QT_VER#n\2"

3
doc/config/exampleurl-qttools.qdocconf
View File

@ -1 +1,4 @@
url.examples = "https://code.qt.io/cgit/qt/qttools.git/tree/examples/\1?h=$QT_VER"
# Automatic linking to declarations of C++ APIs
url.sources = "https://code.qt.io/cgit/qt/qttools.git/tree/\1?h=$QT_VER#n\2"

3
doc/config/exampleurl-qtvirtualkeyboard.qdocconf
View File

@ -1 +1,4 @@
url.examples = "https://code.qt.io/cgit/qt/qtvirtualkeyboard.git/tree/examples/\1?h=$QT_VER"
# Automatic linking to declarations of C++ APIs
url.sources = "https://code.qt.io/cgit/qt/qtvirtualkeyboard.git/tree/\1?h=$QT_VER#n\2"

3
doc/config/exampleurl-qtwayland.qdocconf
View File

@ -1 +1,4 @@
url.examples = "https://code.qt.io/cgit/qt/qtwayland.git/tree/examples/\1?h=$QT_VER"
# Automatic linking to declarations of C++ APIs
url.sources = "https://code.qt.io/cgit/qt/qtwayland.git/tree/\1?h=$QT_VER#n\2"

3
doc/config/exampleurl-qtwebchannel.qdocconf
View File

@ -1 +1,4 @@
url.examples = "https://code.qt.io/cgit/qt/qtwebchannel.git/tree/examples/\1?h=$QT_VER"
# Automatic linking to declarations of C++ APIs
url.sources = "https://code.qt.io/cgit/qt/qtwebchannel.git/tree/\1?h=$QT_VER#n\2"

3
doc/config/exampleurl-qtwebengine.qdocconf
View File

@ -1 +1,4 @@
url.examples = "https://code.qt.io/cgit/qt/qtwebengine.git/tree/examples/\1?h=$QT_VER"
# Automatic linking to declarations of C++ APIs
url.sources = "https://code.qt.io/cgit/qt/qtwebengine.git/tree/\1?h=$QT_VER#n\2"

3
doc/config/exampleurl-qtwebsockets.qdocconf
View File

@ -1 +1,4 @@
url.examples = "https://code.qt.io/cgit/qt/qtwebsockets.git/tree/examples/\1?h=$QT_VER"
# Automatic linking to declarations of C++ APIs
url.sources = "https://code.qt.io/cgit/qt/qtwebsockets.git/tree/\1?h=$QT_VER#n\2"

3
doc/config/exampleurl-qtwebview.qdocconf
View File

@ -1 +1,4 @@
url.examples = "https://code.qt.io/cgit/qt/qtwebview.git/tree/examples/\1?h=$QT_VER"
# Automatic linking to declarations of C++ APIs
url.sources = "https://code.qt.io/cgit/qt/qtwebview.git/tree/\1?h=$QT_VER#n\2"

3
doc/global/qt-module-defaults-online.qdocconf
View File

@ -29,6 +29,9 @@ include(macros-online.qdocconf)
#extra configuration data DITA information
include(config.qdocconf)
# Enable automatic linking to sources
url.sources.enabled = true
# single-directory output mode
HTML.nosubdirs = "true"
HTML.outputsubdir = "../html"

3
src/concurrent/doc/qtconcurrent.qdocconf
View File

@ -7,6 +7,9 @@ version = $QT_VERSION
examplesinstallpath = qtconcurrent
# Path to the root of qtbase (for automatic linking to source code)
url.sources.rootdir = ../../..
qhp.projects = QtConcurrent
qhp.QtConcurrent.file = qtconcurrent.qhp

3
src/corelib/doc/qtcore.qdocconf
View File

@ -10,6 +10,9 @@ includepaths += ./include
examplesinstallpath = corelib
# Path to the root of qtbase (for automatic linking to source code)
url.sources.rootdir = ../../..
qhp.projects = QtCore
qhp.QtCore.file = qtcore.qhp

3
src/dbus/doc/qtdbus.qdocconf
View File

@ -25,6 +25,9 @@ excludedirs += ../../../examples/widgets/doc
examplesinstallpath = dbus
# Path to the root of qtbase (for automatic linking to source code)
url.sources.rootdir = ../../..
tagfile = qtdbus.tags
depends += qtcore qtdoc qmake qtcmake

3
src/gui/doc/qtgui.qdocconf
View File

@ -10,6 +10,9 @@ moduleheader = QtGuiDoc
examplesinstallpath = gui
# Path to the root of qtbase (for automatic linking to source code)
url.sources.rootdir = ../../..
qhp.projects = QtGui
qhp.QtGui.file = qtgui.qhp

3
src/network/doc/qtnetwork.qdocconf
View File

@ -7,6 +7,9 @@ version = $QT_VERSION
examplesinstallpath = network
# Path to the root of qtbase (for automatic linking to source code)
url.sources.rootdir = ../../..
qhp.projects = QtNetwork
qhp.QtNetwork.file = qtnetwork.qhp

3
src/opengl/doc/qtopengl.qdocconf
View File

@ -31,6 +31,9 @@ depends += qtcore qtgui qtwidgets qtdoc qmake qtcmake qtquick
examplesinstallpath = opengl
# Path to the root of qtbase (for automatic linking to source code)
url.sources.rootdir = ../../..
tagfile = qtopengl.tags
# The following parameters are for creating a qhp file, the qhelpgenerator

3
src/printsupport/doc/qtprintsupport.qdocconf
View File

@ -7,6 +7,9 @@ version = $QT_VERSION
examplesinstallpath = printsupport
# Path to the root of qtbase (for automatic linking to source code)
url.sources.rootdir = ../../..
qhp.projects = QtPrintSupport
qhp.QtPrintSupport.file = qtprintsupport.qhp

3
src/sql/doc/qtsql.qdocconf
View File

@ -7,6 +7,9 @@ version = $QT_VERSION
examplesinstallpath = sql
# Path to the root of qtbase (for automatic linking to source code)
url.sources.rootdir = ../../..
qhp.projects = QtSql
qhp.QtSql.file = qtsql.qhp

3
src/testlib/doc/qttestlib.qdocconf
View File

@ -8,6 +8,9 @@ version = $QT_VERSION
examplesinstallpath = qtestlib
# Path to the root of qtbase (for automatic linking to source code)
url.sources.rootdir = ../../..
qhp.projects = QtTestLib
qhp.QtTestLib.file = qttestlib.qhp

3
src/widgets/doc/qtwidgets.qdocconf
View File

@ -10,6 +10,9 @@ includepaths += -I./macOS
examplesinstallpath = widgets
# Path to the root of qtbase (for automatic linking to source code)
url.sources.rootdir = ../../..
qhp.projects = QtWidgets
qhp.QtWidgets.file = qtwidgets.qhp

3
src/xml/doc/qtxml.qdocconf
View File

@ -7,6 +7,9 @@ version = $QT_VERSION
examplesinstallpath = xml
# Path to the root of qtbase (for automatic linking to source code)
url.sources.rootdir = ../../..
qhp.projects = QtXml
qhp.QtXml.file = qtxml.qhp