summaryrefslogtreecommitdiffstats
path: root/doc/global/config.qdocconf
Commit message (Collapse)AuthorAgeFilesLines
* Doc: Add WebSocket(s) as words ignored for auto-linkingTopi Reinio2020-07-021-0/+2
| | | | | | | | | | | 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>
* Doc: Update global documentation config for Qt 6Topi Reinio2020-06-081-1/+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>
* Bump copyright yearJani Heikkinen2020-01-091-1/+1
| | | | | | Change-Id: I9468ef21a2cf03cf07c38f012a2aa9bae6d02a03 Reviewed-by: Johanna Äijälä <johanna.aijala@qt.io> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Doc: Prevent QDoc from auto-linking certain wordsv5.14.0-beta2Topi Reinio2019-10-191-0/+6
| | | | | | | | | | | | | | | | | | '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>
* Bump copyright year to 2019Kai Koehne2018-12-181-1/+1
| | | | | | | | Task-number: QTBUG-72635 Change-Id: Idc9bd97fe873b332d7ff72cb44a00334a472404f Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Alex Blasche <alexander.blasche@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Use index.html as the home page referenceTopi Reinio2018-06-051-1/+2
| | | | | | | | | | | 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>
* Doc: Increment copyright year in global doc templatesLeena Miettinen2018-04-041-1/+1
| | | | | | | Change-Id: I687ea95c0985c361ffb75ea3c162615b0abbb7f7 Reviewed-by: Eike Ziller <eike.ziller@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Add a comment into config.qdocconf about generating internal docsTopi Reinio2017-02-071-0/+4
| | | | | | | | | | | | | | 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>
* Doc: Documentation template: Bump copyright yearTopi Reinio2017-01-261-1/+1
| | | | | Change-Id: Ic2dfce35f9bfabc94b170f3dfaa3172630918330 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Automatically generate code attribution documentationKai Koehne2016-08-101-1/+1
| | | | | | | | | | | 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>
* Bump copyright year to 2016Kai Koehne2016-01-291-1/+1
| | | | | | | | | | Bump copyright year in tool output and user visible strings to 2016. Task-number: QTBUG-50578 Change-Id: I2f4aa9089c6672726f554cba7e6009b425d27683 Reviewed-by: Liang Qi <liang.qi@theqtcompany.com> Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com> Reviewed-by: Martin Smith <martin.smith@theqtcompany.com>
* Update copyright headersJani Heikkinen2015-02-111-1/+1
| | | | | | | | | | | | | | | | | | 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>
* Bump copyright year to 2015Kai Koehne2015-01-151-1/+1
| | | | | | | | Bump copyright year in tool output and user visible strings to 2015. Change-Id: I9b29907fe3f555e78005cb296a49d92f601fb7ec Reviewed-by: Lars Knoll <lars.knoll@digia.com> Reviewed-by: Martin Smith <martin.smith@digia.com>
* Doc: new template for qt.io online styleTopi Reinio2014-12-031-2/+1
| | | | | | | | | | | | An online documentation template that follows the style of qt.io site. Update the url variable for Qt modules to point to doc.qt.io/qt-5/. Task-number: QTBUG-42086 Change-Id: I5428a02cd503aef2217efd7361f4c8b7b5895a52 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
* Doc: Removed minor version from the doc URL.Jerome Pasion2014-08-151-1/+1
| | | | | | | | | | | -The online URL doesn't use the minor version anymore and this makes the non-Qt projects depend on the existence of redirects. Change-Id: I5b2bef16957ca307060600b7bf25eb1d55f2c998 Reviewed-by: Topi Reiniö <topi.reinio@digia.com> Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Add Qt 5 URL in qtbase/doc/globalJerome Pasion2014-07-041-0/+2
| | | | | | | | -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>
* Doc: Add a section all modules can use for example documentation.Jerome Pasion2014-04-091-0/+2
| | | | | | | | | | | | -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>
* Doc: Update year to 2014Kai Koehne2014-03-271-1/+1
| | | | | | Change-Id: Iae2f31232fb364b26aa4da99048d92c262b4fdec Reviewed-by: Sergio Ahumada <sahumada@blackberry.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Fixed QDoc's navigation mechanism.Jerome Pasion2013-06-251-0/+12
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>
generated by cgit v1.2.3 (git 2.25.1) at 2024-05-02 08:56:02 +0000