qiurui
/
qtgrpc
mirror of https://github.com/qt/qtgrpc.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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

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 for modules in
qtgrpc.

Change-Id: I09020881035bde71470ccb8c77d7905321f56251
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
This commit is contained in:
Topi Reinio 2025-05-19 12:21:39 +00:00
parent eebbc89765
commit 3691055700
2 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/grpc/doc/qtgrpc.qdocconf
View File

@ -7,7 +7,9 @@ version = $QT_VERSION
examplesinstallpath = grpc examplesinstallpath = grpc
examples.fileextensions += "*.proto" examples.fileextensions += "*.proto"
url.examples = "https://code.qt.io/cgit/qt/qtgrpc.git/tree/examples/\1?h=$QT_VER" url.examples = "https://code.qt.io/cgit/qt/qtgrpc.git/tree/examples/\1?h=$QT_VER"
url.sources = "https://code.qt.io/cgit/qt/qtgrpc.git/tree/\1?h=$QT_VER#n\2"
# Path to the root of qtgrpc (for automatic linking to source code)
url.sources.rootdir = ../../..
qhp.projects = QtGrpc qhp.projects = QtGrpc
qhp.QtGrpc.file = qtgrpc.qhp qhp.QtGrpc.file = qtgrpc.qhp

3
src/protobuf/doc/qtprotobuf.qdocconf
View File

@ -7,6 +7,9 @@ version = $QT_VERSION
examplesinstallpath = protobuf examplesinstallpath = protobuf
examples.fileextensions += "*.proto" examples.fileextensions += "*.proto"
url.examples = "https://code.qt.io/cgit/qt/qtgrpc.git/tree/examples/\1?h=$QT_VER" url.examples = "https://code.qt.io/cgit/qt/qtgrpc.git/tree/examples/\1?h=$QT_VER"
url.sources = "https://code.qt.io/cgit/qt/qtgrpc.git/tree/\1?h=$QT_VER#n\2"
# Path to the root of qtgrpc (for automatic linking to source code)
url.sources.rootdir = ../../..
qhp.projects = QtProtobuf qhp.projects = QtProtobuf
moduleheader = ${project}Doc moduleheader = ${project}Doc