summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlexei Cazacov <alexei.cazacov@qt.io>2025-12-11 10:37:48 +0200
committerQt Cherry-pick Bot <cherrypick_bot@qt-project.org>2025-12-11 18:37:46 +0000
commitfb3f1511e11f1476c2ae338dcb0f4f280cbea52f (patch)
treee1a8392c176e4a9f9e7e7e3b726b8037661d1bb8
parent654270e210ae087fb4a68e677a5cc2663b235648 (diff)
Doc: Create a TOC for the qtnetworkauth module6.10
Task-number: QTBUG-142688 Change-Id: Ic34bf268f5eb2503b8ed1ae82f5abeb27b5d7f47 Reviewed-by: Jesus Fernandez <jsfdez@gmail.com> (cherry picked from commit 80ca1150727e821c2c445a226e1372ba57a9b679) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> (cherry picked from commit ccef3091f61ebfe6487ca777340c41f9bb0957da)
-rw-r--r--src/oauth/doc/qtnetworkauth.qdocconf25
-rw-r--r--src/oauth/doc/src/qtnetworkauth-toc.qdoc15
2 files changed, 32 insertions, 8 deletions
diff --git a/src/oauth/doc/qtnetworkauth.qdocconf b/src/oauth/doc/qtnetworkauth.qdocconf
index 615c78e..36ab6ee 100644
--- a/src/oauth/doc/qtnetworkauth.qdocconf
+++ b/src/oauth/doc/qtnetworkauth.qdocconf
@@ -14,15 +14,20 @@ qhp.QtNetworkAuth.virtualFolder = qtnetworkauth
qhp.QtNetworkAuth.indexTitle = Qt Network Authorization
qhp.QtNetworkAuth.indexRoot =
-qhp.QtNetworkAuth.subprojects = overview classes
-qhp.QtNetworkAuth.subprojects.overview.title = Overview
-qhp.QtNetworkAuth.subprojects.overview.indexTitle = OAuth 2.0 Overview
-qhp.QtNetworkAuth.subprojects.overview.selectors = group:none
+qhp.QtNetworkAuth.subprojects = manual examples classes
+qhp.QtNetworkAuth.subprojects.manual.title = Qt Network Authorization
+qhp.QtNetworkAuth.subprojects.manual.indexTitle = Qt Network Authorization module topics
+qhp.QtNetworkAuth.subprojects.manual.type = manual
-qhp.QtNetworkAuth.subprojects.classes.title = C++ Classes
-qhp.QtNetworkAuth.subprojects.classes.indexTitle = Qt Network Authorization C++ Classes
-qhp.QtNetworkAuth.subprojects.classes.selectors = class doc:headerfile
-qhp.QtNetworkAuth.subprojects.classes.sortPages = true
+qhp.QtNetworkAuth.subprojects.examples.title = Examples
+qhp.QtNetworkAuth.subprojects.examples.indexTitle = Qt Network Authorization Examples
+qhp.QtNetworkAuth.subprojects.examples.selectors = example
+qhp.QtNetworkAuth.subprojects.examples.sortPages = true
+
+qhp.QtNetworkAuth.subprojects.classes.title = C++ Classes
+qhp.QtNetworkAuth.subprojects.classes.indexTitle = Qt Network Authorization C++ Classes
+qhp.QtNetworkAuth.subprojects.classes.selectors = class doc:headerfile
+qhp.QtNetworkAuth.subprojects.classes.sortPages = true
tagfile = qtnetworkauth.tags
@@ -40,5 +45,9 @@ exampledirs += ../../../examples/oauth snippets
navigation.landingpage = "Qt Network Authorization"
navigation.cppclassespage = "Qt Network Authorization C++ Classes"
+# Autogenerate navigation linking based on "Qt Network Authorization module topics":
+navigation.toctitles = "Qt Network Authorization module topics"
+navigation.toctitles.inclusive = false
+
# Enforce zero documentation warnings
warninglimit = 0
diff --git a/src/oauth/doc/src/qtnetworkauth-toc.qdoc b/src/oauth/doc/src/qtnetworkauth-toc.qdoc
new file mode 100644
index 0000000..558e572
--- /dev/null
+++ b/src/oauth/doc/src/qtnetworkauth-toc.qdoc
@@ -0,0 +1,15 @@
+
+// Copyright (C) 2025 The Qt Company Ltd.
+// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
+/*!
+ \page qtnetworkauth-toc.html
+ \title Qt Network Authorization module topics
+ The following list has links to all the individual topics (HTML files)
+ in the Qt Network Authorization module.
+
+ \list
+ \li \l {OAuth 2.0 Overview}{Overview}
+ \li \l {Qt OAuth2 Browser Support}{Browser Support}
+ \li \l {Qt Network Authorization Security Considerations}{Security Considerations}
+\endlist
+*/