diff options
| author | Eike Ziller <eike.ziller@qt.io> | 2019-10-07 07:46:48 +0200 |
|---|---|---|
| committer | Eike Ziller <eike.ziller@qt.io> | 2019-12-16 11:03:31 +0000 |
| commit | 3dfa18818240006d1458f8f9104b4b8c336a60e0 (patch) | |
| tree | e6efb3950e62afa432a5da5bb41f0b28f79f2164 /doc | |
| parent | 6b492866af89365a6f1083334460bffa8c31cc3e (diff) | |
| download | qt-creator-3dfa18818240006d1458f8f9104b4b8c336a60e0.tar.gz | |
Help: Add option to only register highest versioned Qt documentation
In Options > Kits > Qt Versions. And make it the default.
It registers each documentation file only for the highest registered Qt
version. If you have Qt 5.12 and Qt 5.13 registered, but only installed
QtWebEngine for Qt 5.12, you'll get QtWebEngine documentation for Qt
5.12, but the other documentation is from Qt 5.13.
That is usually sufficient, since the documentation still contains "old"
API, and new API is flagged with "since".
This avoids registering a lot of documentation, which creates a startup
performance issue, and also leads to usually unneeded popups for which
Qt version some documentation should be shown.
The option also allows going back to registering all documentation,
and no Qt documentation at all.
Fixes: QTCREATORBUG-21482
Fixes: QTCREATORBUG-22799
Task-number: QTCREATORBUG-10004
Change-Id: I1c7bc73982d48d8e53f5083e2fa851b6c5f60f80
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Jarek Kobus <jaroslaw.kobus@qt.io>
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/src/projects/creator-only/creator-projects-qt-versions.qdoc | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/src/projects/creator-only/creator-projects-qt-versions.qdoc b/doc/src/projects/creator-only/creator-projects-qt-versions.qdoc index f0bff5d0bf..58539f5534 100644 --- a/doc/src/projects/creator-only/creator-projects-qt-versions.qdoc +++ b/doc/src/projects/creator-only/creator-projects-qt-versions.qdoc @@ -80,6 +80,16 @@ \endlist + \section1 Documentation + + By default, \QC registers only the latest available version of the documentation for each + installed Qt module. + + To register the documentation sets of all installed Qt versions, choose + \uicontrol{All} from the \uicontrol{Register documentation} list. + To register no Qt documentation at all, choose \uicontrol{None}. + The default behavior is \uicontrol{Highest Version Only}. + \section1 Troubleshooting Qt Installations If \QC detects problems in the installation of a Qt version, it displays |