AuroraMiddleware/qt5base-lts
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
266c2d23ae
qt5base-lts/doc/global/config.qdocconf

40 lines
988 B
Plaintext
Raw Normal View History

Doc: Fixed QDoc's navigation mechanism. The HTML pages need to display minimal navigation such as a link to the module landing page or Qt 5's index.html. -new variables available in qdocconf files: navigation.landingpage navigation.homepage navigation.cppclassespage navigation.qmltypespage buildversion The navigation variables are for the new navigation bar. The buildversion variable is to insert documentation build information into the pages. Note about compatibility with Qt Creator docs: The HTML template files for Qt Creator is retained to keep Qt Creator compatible with 5.0.x and 5.1.x. Change-Id: Ibb4d7cada19644204457d822b6b77b2aa7b70f8d Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@digia.com>
2013-02-19 16:54:54 +00:00
#Include this file to inherit configuration related to Qt Project based modules.
dita.metadata.default.author = Qt Project
dita.metadata.default.permissions = all
dita.metadata.default.publisher = Qt Project
Doc: Update copyright year in the template Pick-to: 6.2 6.4 6.5 Fixes: QTBUG-110271 Change-Id: I70ce5356941d2499a219ab9fb1875df23acda3dc Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
2023-02-07 12:31:42 +00:00
dita.metadata.default.copyryear = 2023
Update copyright headers Qt copyrights are now in The Qt Company, so we could update the source code headers accordingly. In the same go we should also fix the links to point to qt.io. Outdated header.LGPL removed (use header.LGPL21 instead) Old header.LGPL3 renamed to header.LGPL3-COMM to match actual licensing combination. New header.LGPL-COMM taken in the use file which were using old header.LGPL3 (src/plugins/platforms/android/extract.cpp) Added new header.LGPL3 containing Commercial + LGPLv3 + GPLv2 license combination Change-Id: I6f49b819a8a20cc4f88b794a8f6726d975e8ffbe Reviewed-by: Matti Paaso <matti.paaso@theqtcompany.com>
2015-01-28 08:44:43 +00:00
dita.metadata.default.copyrholder = The Qt Company Ltd
Doc: Fixed QDoc's navigation mechanism. The HTML pages need to display minimal navigation such as a link to the module landing page or Qt 5's index.html. -new variables available in qdocconf files: navigation.landingpage navigation.homepage navigation.cppclassespage navigation.qmltypespage buildversion The navigation variables are for the new navigation bar. The buildversion variable is to insert documentation build information into the pages. Note about compatibility with Qt Creator docs: The HTML template files for Qt Creator is retained to keep Qt Creator compatible with 5.0.x and 5.1.x. Change-Id: Ibb4d7cada19644204457d822b6b77b2aa7b70f8d Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@digia.com>
2013-02-19 16:54:54 +00:00
dita.metadata.default.audience = programmer
#Set the main Qt index.html
Doc: Use index.html as the home page reference QDoc links to the homepage in the navigation bar; use index.html for linking instead of "Qt $QT_VER" to prevent incorrect links to section titles that clash with that string. Task-number: QTBUG-62484 Change-Id: I53ced31b7ce35d69579a8c70cbc475e306fd3b18 Reviewed-by: Martin Smith <martin.smith@qt.io>
2018-06-05 10:58:09 +00:00
navigation.homepage = index.html
navigation.hometitle = "Qt $QT_VER"
Doc: Add a section all modules can use for example documentation. -modules that use the qt-module-defaults.qdocconf have access to the .qdocinc file. -content about running examples can be used by example documentation. Task-number: QTBUG-33597 Change-Id: I88d93a9982c05a24b4f7ac1b2cfb3293e56031b2 Reviewed-by: Topi Reiniö <topi.reinio@digia.com> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
2014-04-08 12:59:37 +00:00
Doc: Prevent QDoc from auto-linking certain words 'macOS' appears in the documentation frequently, and because it resembles a variable/property name, QDoc links each occurrence of it. 'WebChannel' appears as part of a module name, but it's also a QML type - auto-linking each word to QML documentation is confusing. Likewise, there's no need to link 'OpenGL' each time. Explicit links such as \l [QML] WebChannel continue to work. Task-number: QTBUG-79135 Change-Id: I76cc84b0076255e260aa88c244102702a48f35a6 Reviewed-by: Martin Smith <martin.smith@qt.io>
2019-10-17 08:24:12 +00:00
#Words to ignore for auto-linking
ignorewords += \
macOS \
WebChannel \
Doc: Add WebSocket(s) as words ignored for auto-linking These strings qualify for auto-linking and therefore result in unnecessary hyperlinks whenever 'Qt WebSockets' appears in the documentation. Pick-to: 5.15 Task-number: QTBUG-85388 Change-Id: I969125d4d5367f2373eef75180fe36817e3507d9 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2020-07-02 13:15:34 +00:00
WebSocket \
WebSockets \
Doc: Prevent QDoc from auto-linking certain words 'macOS' appears in the documentation frequently, and because it resembles a variable/property name, QDoc links each occurrence of it. 'WebChannel' appears as part of a module name, but it's also a QML type - auto-linking each word to QML documentation is confusing. Likewise, there's no need to link 'OpenGL' each time. Explicit links such as \l [QML] WebChannel continue to work. Task-number: QTBUG-79135 Change-Id: I76cc84b0076255e260aa88c244102702a48f35a6 Reviewed-by: Martin Smith <martin.smith@qt.io>
2019-10-17 08:24:12 +00:00
OpenGL
Doc: Do ignore \since 5.x We only support Qt 5.15 since a while, so the detailed information in which Qt 5 version a particular class, function, or enum was introduced is becoming less and less relevant. Pick-to: 6.5 Change-Id: I39bd579f23abc0ac84879e9bd22e6a97651ef7c3 Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io> Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2023-01-10 16:09:15 +00:00
# Omit \since information for items introduced before Qt 6
ignoresince = 6.0
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>
2020-06-07 09:03:02 +00:00
Automatically generate code attribution documentation Let the qtattributionsscanner tool generate a .qdoc file in the build directory that contains code attributions for this qdoc module. Task-number: QTBUG-55139 Change-Id: Ic7532c9a7c092f552c36e21ee6cbebdd0107689b Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@theqtcompany.com> Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
2016-07-01 14:14:31 +00:00
sourcedirs += includes $$BUILDDIR
Move the docs for porting to QRegularExpression to a common place Copy them from QRegExp docs in qt5compat to doc/global/includes/corelib/port-from-qregexp.qdocinc, so that the porting docs can be included from both Qt 6 porting guide and qt5compat. Task-number: QTBUG-89702 Pick-to: 6.4 6.3 6.2 Change-Id: I616e2333f60f36e4851398479939fd062016748d Reviewed-by: Edward Welbourne <edward.welbourne@qt.io>
2022-07-05 14:18:13 +00:00
exampledirs += snippets
Doc: Add Qt 5 URL in qtbase/doc/global -individual Qt 5 modules have the same URL and it can be inherited from doc/global Change-Id: Ie53fe7509a4f906740512e290e263d34ba3f2ee6 Reviewed-by: Martin Smith <martin.smith@digia.com>
2014-07-03 14:36:02 +00:00
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>
2020-06-07 09:03:02 +00:00
url = https://doc.qt.io/qt
defines += qt6
Doc: Add a comment into config.qdocconf about generating internal docs QDoc supports the --showinternal command line option, but it's not integrated to the build system. This commit documents an alternative way to get documentation marked as internal generated, replacing every instance of \internal with a text string '[internal]' Change-Id: Ib48ade21adf32d430e62b95c4baa64be620d7eb0 Reviewed-by: Andy Shaw <andy.shaw@qt.io> Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> Reviewed-by: Martin Smith <martin.smith@qt.io>
2017-02-03 14:33:18 +00:00
Doc: Require Qt module documentation to define qhp configuration By setting 'qhp' to true, QDoc will warn if qhp configuration is not provided. Pick-to: 6.6 6.5 Task-number: QTBUG-114181 Change-Id: I26bce80e888d0b0bd270ecdcc6c0774298076a4b Reviewed-by: Topi Reiniö <topi.reinio@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2023-06-02 13:38:57 +00:00
# Require Qt modules to define qhp.projects
qhp = true
Doc: Stop writing host-specific paths to generated .index files By default QDoc writes filePath attributes for each entry in the .index file it generates. The attribute value is an absolute path that's only relevant or useful for debugging purposes. Pick-to: 6.6 6.5 Change-Id: I3bc646104af74b67c74350912359cf65ac252992 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2023-06-08 09:54:28 +00:00
# Disable writing host-specific paths into .index files
locationinfo = false
Use a global value for warning limit when testing documentation in CI The most common limit for the maximum number of allowed documentation warnings is zero. Use a global value for 'warninglimit', adopted by all Qt module documentation projects that include the configuration from qtbase/doc/global. This allows for a temporary increase of the limit across all modules as needed - for example, when updating the QDoc binary that the CI provisions to a version that introduces new types of documentation warnings. Increase this base limit temporarily to 10 to help re-enable documentation testing in CI as it's currently disabled. Task-number: QTBUG-113326 Change-Id: I8b66951ca9324bcfaec3b5a7ec2cff544c62feb0 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2023-06-27 09:12:56 +00:00
# Include the warninglimit used for documentation testing in CI
Doc: Move the warninglimit configuration to doc/global The /coin directory is not installed, so trying to include a .qdocconf file using a relative path from an (installed) global configuration will fail. Task-number: QTBUG-113326 Change-Id: I761b1a7eb19ca9d6a768f1367e30d5eaf80cb816 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2023-06-29 09:04:35 +00:00
include(warninglimit.qdocconf)
Reference in New Issue Copy Permalink