summaryrefslogtreecommitdiffstats
path: root/doc/global
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@qt.io>2020-06-07 11:03:02 +0200
committerTopi Reinio <topi.reinio@qt.io>2020-06-08 13:41:07 +0200
commit2df31c8f2e044de68898bd744adec676d75b2e7e (patch)
tree274c3158e7c7d76e93c9acd1c885f52a3de141b4 /doc/global
parenta85c7342ad7592f44727cfc4b9a4ed3b1442bb2a (diff)
Doc: Update global documentation config for Qt 6
- Set base URL path to /qt - Define 'qt6' for use in conditionals - Omit \since information for everything introduced before Qt 5 - Make use of the new expandable variables to allow component-specific URLs in commercial templates - Adjust CSS for changes in QDoc's output Change-Id: I74581f0fb49cd176f92d6451c388e7b7ddf1baa4 Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
Diffstat (limited to 'doc/global')
-rw-r--r--doc/global/config.qdocconf7
-rw-r--r--doc/global/qt-module-defaults-online-commercial.qdocconf8
-rw-r--r--doc/global/template/style/offline-simple.css2
-rw-r--r--doc/global/template/style/offline.css8
-rw-r--r--doc/global/template/style/online.css9
5 files changed, 15 insertions, 19 deletions
diff --git a/doc/global/config.qdocconf b/doc/global/config.qdocconf
index 8df9b4f30d..d53e124b92 100644
--- a/doc/global/config.qdocconf
+++ b/doc/global/config.qdocconf
@@ -17,9 +17,14 @@ ignorewords += \
WebChannel \
OpenGL
+# Omit \since information for items introduced before Qt 5
+ignoresince = 5.0
+
sourcedirs += includes $$BUILDDIR
-url = http://doc.qt.io/qt-5
+url = https://doc.qt.io/qt
+
+defines += qt6
# Uncomment the following two lines to generate documentation marked as \internal
# alias.internal = disable
diff --git a/doc/global/qt-module-defaults-online-commercial.qdocconf b/doc/global/qt-module-defaults-online-commercial.qdocconf
index c5bce13609..3d21ea0122 100644
--- a/doc/global/qt-module-defaults-online-commercial.qdocconf
+++ b/doc/global/qt-module-defaults-online-commercial.qdocconf
@@ -1,15 +1,17 @@
# This template uses the default online template for qt.io
# and modifies it for a commercial Qt component
+# URL specific to this component - override as needed
+componenturl = https://www.qt.io/download/
+
# Start of footer - the rest is defined in the default template
HTML.footer = \
- " <p class=\"qt_commercial\">Available under certain Qt licenses.<br/><a href=\"http://www.qt.io/download/\">Find out more.</a></p>\n" \
+ " <p class=\"qt_commercial\">Available under certain Qt licenses.<br/><a href=\"${componenturl}\" target=\"_blank\">Find out more.</a></p>\n" \
" </div>\n"
include(macros.qdocconf)
include(qt-cpp-defines.qdocconf)
include(compat.qdocconf)
-#include(manifest-meta.qdocconf)
include(fileextensions.qdocconf)
include(qt-html-templates-online.qdocconf)
@@ -18,7 +20,7 @@ include(config.qdocconf)
HTML.prologue = \
"<div class=\"context qt_commercial\">\n" \
- "<a href=\"http://www.qt.io/download/\" title=\"Available under certain Qt licenses.\" ><h1 class=\"qt_commercial\">C</h1></a>\n"
+ "<a href=\"${componenturl}\" target=\"_blank\" title=\"Available under certain Qt licenses.\" ><h1 class=\"qt_commercial\">C</h1></a>\n"
# Turn off single-directory output mode
HTML.nosubdirs = "false"
diff --git a/doc/global/template/style/offline-simple.css b/doc/global/template/style/offline-simple.css
index b89ca5a808..83fa15ca17 100644
--- a/doc/global/template/style/offline-simple.css
+++ b/doc/global/template/style/offline-simple.css
@@ -102,7 +102,7 @@ h3.fn .name, h3.fn .type {
font-weight: 400;
}
-.qmlreadonly, .qmldefault {
+.qmlextra {
font-family: Courier, monospace;
margin-right: 6px;
}
diff --git a/doc/global/template/style/offline.css b/doc/global/template/style/offline.css
index f99369a096..3f99aec978 100644
--- a/doc/global/template/style/offline.css
+++ b/doc/global/template/style/offline.css
@@ -586,13 +586,7 @@ ol.a > li{
padding: 20px 20px 20px 20px;
}
-.qmldefault {
- padding-left: 5px;
- float: right;
- color: red;
-}
-
-.qmlreadonly {
+.qmlextra {
padding-left: 5px;
float: right;
color: #254117;
diff --git a/doc/global/template/style/online.css b/doc/global/template/style/online.css
index 4e17d9a8a9..a21dca37ae 100644
--- a/doc/global/template/style/online.css
+++ b/doc/global/template/style/online.css
@@ -489,18 +489,13 @@ h1,h2,h3,h4,h5,h6 {
text-align:left;
padding:5px 0 0 0
}
-.qmlreadonly,.qmldefault {
+.qmlreadonly,.qmldefault,.qmlextra {
+ color:#414141;
padding:0 5px 0 5px;
font-size:0.75em;
background-color:#eee;
float:right
}
-.qmlreadonly {
- color:#414141
-}
-.qmldefault {
- color:#D14141
-}
.rightAlign {
padding:3px 5px 3px 10px;
text-align:right