From 36910557000f286ebf943f1adef21a678ba53da1 Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Mon, 19 May 2025 12:21:39 +0000 Subject: [PATCH] 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 --- src/grpc/doc/qtgrpc.qdocconf | 4 +++- src/protobuf/doc/qtprotobuf.qdocconf | 3 +++ 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/src/grpc/doc/qtgrpc.qdocconf b/src/grpc/doc/qtgrpc.qdocconf index c046261c..ab0502d8 100644 --- a/src/grpc/doc/qtgrpc.qdocconf +++ b/src/grpc/doc/qtgrpc.qdocconf @@ -7,7 +7,9 @@ version = $QT_VERSION examplesinstallpath = grpc examples.fileextensions += "*.proto" 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.QtGrpc.file = qtgrpc.qhp diff --git a/src/protobuf/doc/qtprotobuf.qdocconf b/src/protobuf/doc/qtprotobuf.qdocconf index 11a7361a..337957e7 100644 --- a/src/protobuf/doc/qtprotobuf.qdocconf +++ b/src/protobuf/doc/qtprotobuf.qdocconf @@ -7,6 +7,9 @@ version = $QT_VERSION examplesinstallpath = protobuf examples.fileextensions += "*.proto" 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 moduleheader = ${project}Doc