summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Document that QStandardPath::findExecutable works with absolute pathsAlbert Astals Cid2022-03-161-0/+3
| | | | | | | Change-Id: Ib993fa9a5f2c68febac9820e241c8617bb8ba5bc Reviewed-by: Thiago Macieira <thiago.macieira@intel.com> (cherry picked from commit ea10fe66e53188767c5090b3b25d5bb7732c73a8) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* Update copyright year to 2022Kai Köhne2022-01-064-4/+4
| | | | | | | | Task-number: QTBUG-99345 Change-Id: If6f1d6f9f82a601f8e2b6d36650d6e737518aa60 Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Topi Reiniö <topi.reinio@qt.io> (cherry picked from commit 6205cb161d393f96c670d57bca29fed2dcfda14c)
* Doc: Update external links to Qt Creator ManualLeena Miettinen2022-01-051-204/+242
| | | | | | | | | | | | | | | Sync with Qt Creator Manual 6.0.0. Remove topics related to using Qt Quick Designer plugin because they are now in the Qt Design Studio Manual, only. Add new topics and fix some topic titles. Some topics also exist in Qt Design Studio Manual and can be accessed with the "Qt Design Studio:" prefix. Change-Id: Ie4f07b0a1602f3318ca5335ee72130ddce12801e Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> (cherry picked from commit c68b057510b59ee369f0d3255822d841d6d4a7fd) Reviewed-by: Tarja Sundqvist <tarja.sundqvist@qt.io>
* Doc: Add styling for note/warning/important admonitionsTopi Reinio2021-11-032-28/+26
| | | | | | | | | | | | The offline CSS already had some related rules, but at some point QDoc lost the ability to produce the required markup. It has now been reintroduced. Task-number: QTBUG-97448 Change-Id: I5165cd01f3653dfb35854ca6b8040e8daa434347 Reviewed-by: Paul Wicking <paul.wicking@qt.io> (cherry picked from commit f6bb68c54810cc877ede4d5d3dcb155cc5ea2b4e) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* Add note on selecting the device which is used to run tests on AndroidAssam Boudjelthia2021-08-231-0/+4
| | | | | | | Change-Id: I9bcff18ca11fbbfdff968e29190cae488de56263 Reviewed-by: Edward Welbourne <edward.welbourne@qt.io> (cherry picked from commit 90d8a7bed6f5e3a27d3a908911d2b80ea83b646f) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* Doc: Use https for links to unicode.orgPaul Wicking2021-07-051-0/+5
| | | | | | | | | | | * Change all outbound links in user-facing documentation. * Reflow lines that exceed 100 cols as mandated by clang-format. * Add unicode.org as a global \externalsite. Change-Id: I2ba1e434aa913e678406d62c2801f1a8b2d9e4f4 Reviewed-by: Topi Reiniö <topi.reinio@qt.io> (cherry picked from commit 7968281444c967628566337ce3493058825cb946) Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>
* Doc: Remove styling for hyperlinks from the simplified offline styleTopi Reinio2021-02-191-14/+0
| | | | | | | | | | | | Using a dark theme with the simplified offline style in Qt Assistant results in hard to see links against a dark background. Let the backend style the hyperlinks instead. Fixes: QTBUG-32778 Change-Id: I51ca87f8a526a07a385e42a3c978712ac4d1e91b Reviewed-by: Paul Wicking <paul.wicking@qt.io> (cherry picked from commit 6ab1f926504e7e4ad64e439f1bb0f7c0f4d3ba01) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* Doc: Offline CSS: Reduce excess vertical spacingTopi Reinio2021-02-191-9/+8
| | | | | | | | Fixes: QTBUG-89829 Change-Id: I0beb43fb2f40cbd1e5b36c95322f1a1530f5acf4 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> (cherry picked from commit c4c2ce5b828e3859acf5b998dffb201b2153f5b7) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* Doc: Online CSS: Fix image captions overlapping images used in tablesTopi Reinio2021-02-101-0/+3
| | | | | | | | Fixes: QTBUG-90963 Change-Id: I15c7459246ed6dfa1ad85b732484770babeabfdc Reviewed-by: Paul Wicking <paul.wicking@qt.io> (cherry picked from commit 222c0ab081251f5249f31b6236ca7b912d303816) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* 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. Task-number: QTBUG-85388 Change-Id: I969125d4d5367f2373eef75180fe36817e3507d9 Reviewed-by: Paul Wicking <paul.wicking@qt.io> (cherry picked from commit 0ad35db302a4945edeb057cb77da69b3af63671d) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* Doc: Style the \section3 and \section4 titlesVenugopal Shivashankar2020-06-081-1/+11
| | | | | | | | | | | | This should help visually differentiate between the section titles and the normal text. Change-Id: I5594aac0e0036509e7397999c3df21a90d474d60 Fixes: QTBUG-82694 Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Topi Reiniö <topi.reinio@qt.io> (cherry picked from commit 48b1bc48f1367a47d0c522b4106eb6eba5c699b8) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* Doc: Move the overlapping background logoVenugopal Shivashankar2020-06-021-1/+1
| | | | | | | | | | | Setting the logo to position at the top seems to fix the issue. Fixes: QTWEBSITE-928 Change-Id: I29336b4a1967a4676695b4f7f8560d01f3cf4fdf Reviewed-by: Paul Wicking <paul.wicking@qt.io> (cherry picked from commit 5306fdabc1ceb09875f791526553b3665017f7ce) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* Android: update Android specific variables docsAssam Boudjelthia2020-04-171-0/+16
| | | | | | | | | Android variable are missing from the list of QMake variables... Task-number: QTBUG-80390 Change-Id: Ic10f96687334eea99c0302d7137685b1bf6e56c6 Reviewed-by: BogDan Vatra <bogdan@kdab.com> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Doc: Adjust offline style for the litehtml rendering engineTopi Reinio2020-03-262-20/+7
| | | | | | | | | | | | | | | | | | | | | | | Qt Creator now has the option to use the litehtml backend as a replacement for the QTextBrowser-based help viewer. Fix a few issues that the offline style has with the litehtml renderer: - Fall back to using an unordered list for the navigation bar. - Remove the background image for #buildversion and adjust font size. - Adjust the generated padding around code snippets. Keep the script that switches the offline-simple.css style to the full offline style (offline.css) for JavaScript-enabled browsers. The litehtml backend in Qt Creator will handle this switch internally. With these changes, the generated offline documentation looks acceptable when rendered with QTextBrowser, litehtml, or desktop web browsers. Fixes: QTBUG-82567 Change-Id: I86b179b1985b7ef54feddab30cb227b28021efe5 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Examples: update examples list for AndroidAssam Boudjelthia2020-03-031-78/+97
| | | | | | | | | | Explicitly set the list of examples that works on Android, as many have issues with layout or other issues. Task-number: QTBUG-80716 Change-Id: If71efc45a48c6236f8775e21e4cab6dc0129f024 Reviewed-by: BogDan Vatra <bogdan@kdab.com> Reviewed-by: Eskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@qt.io>
* Merge remote-tracking branch 'origin/5.14' into 5.15Qt Forward Merge Bot2020-01-291-1/+6
|\ | | | | | | Change-Id: I98b1a5a11ece3957a1115c1d9be8841759206ffe
| * Doc: Fix copy-paste error in QOpenGLTexture::Target docsLeena Miettinen2020-01-281-1/+6
| | | | | | | | | | | | | | | | Add a link to https://www.khronos.org/opengl/wiki/Array_Texture. Fixes: QTBUG-49802 Change-Id: Ic740dd758c41a8f3e471a503bd2d02f6d3096f50 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* | Merge remote-tracking branch 'origin/5.14' into 5.15Liang Qi2020-01-094-4/+4
|\ \ | |/ | | | | | | | | | | Conflicts: src/corelib/kernel/qobject.cpp Change-Id: I4780b25665672692b086ee92092e506c814642f2
| * Bump copyright yearJani Heikkinen2020-01-094-4/+4
| | | | | | | | | | | | Change-Id: I9468ef21a2cf03cf07c38f012a2aa9bae6d02a03 Reviewed-by: Johanna Äijälä <johanna.aijala@qt.io> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* | Update macros to work with DocBook supportThibaut Cuvelier2020-01-031-36/+38
|/ | | | | | | Related to https://codereview.qt-project.org/c/qt/qttools/+/276759 Change-Id: Iac9e43ea06b0ef19018094407cde907b38d7c547 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Move the common documentation to a qdocincVenugopal Shivashankar2019-11-181-0/+129
| | | | | | | | | | The member functions of QStandardPath and Qt.labs.platform.StandardPath behave the same, so it's ideal to maintain their documentation in one place. Task-number: QTBUG-79827 Change-Id: I349dbb85cd9b6a3bedac329c0707fc07057cd64b Reviewed-by: Paul Wicking <paul.wicking@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>
* Merge remote-tracking branch 'origin/5.13' into 5.14Friedemann Kleint2019-09-092-3/+49
|\ | | | | | | | | | | | | Conflicts: tests/auto/gui/text/qtextlayout/tst_qtextlayout.cpp Change-Id: Idd3ca5cb9a2b95a4c3513b2a4c8966e6f56193f1
| * Doc: Add external links to new topics in Qt Creator ManualLeena Miettinen2019-09-051-2/+46
| | | | | | | | | | | | | | These topics were added to Qt Creator Manual 4.9 and 4.10. Change-Id: I2e9bf355eb78b5e9877d0ca0bc41de00ed2b4333 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
| * Doc: Add doc/config directory to installed docsTopi Reinio2019-08-131-1/+3
| | | | | | | | | | | | | | | | | | This is needed to copy the .qdocconf files from that directory to QT_INSTALL_DOCS. Task-number: QTBUG-74391 Change-Id: Ia73d5c38c3c9588820401e8098b01f09e63292e4 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* | Remove dead code from Qt 4 timesTor Arne Vestbø2019-08-201-0/+0
| | | | | | | | | | | | | | | | | | | | The benefit of keeping this code around was to inspire or inform changes in the areas to take into account possibly missing features in Qt 5, but at this point that benefit is questionable. We can always use the history to learn about missing pieces if needed. Change-Id: I87a02dc451e9027be9b97554427bf8a1c6b2c025 Reviewed-by: Tor Arne Vestbø <tor.arne.vestbo@qt.io>
* | Introduce Q_NAMESPACE_EXPORTGiuseppe D'Angelo2019-06-281-0/+1
|/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | A recurring problem with the Q_NAMESPACE macro is that it declares an object (staticMetaObject) in the surrounding namespace. That object lacks any export/import qualification to make it usable with shared libraries. Introduce therefore another macro to work around this issue, allowing the user to prefix the object with an exporting macro, f.i. like this: Q_NAMESPACE_EXPORT(Q_CORE_EXPORT) The old macro can simply then be rewritten in terms of this new one, supplying an empty export macro. Note that NOT passing an argument to a macro expecting one is well defined behavior in C99 -- the macro will expand an empty token. Of course, MSVC doesn't like this and emits warnings. As a workaround, use a variadic macro. [ChangeLog][QtCore] Added the new Q_NAMESPACE_EXPORT macro. It can be used just like Q_NAMESPACE to add meta-object information to a namespace; however it also supports exporting of such information from shared libraries. [ChangeLog][Potentially Source-Incompatible Changes] Prefixing Q_NAMESPACE with an export macro may no longer work. Use the new Q_NAMESPACE_EXPORT macro for that use case. Fixes: QTBUG-68014 Change-Id: Ib044a555ace1f77ae8e0244d824ec473550f3d8e Reviewed-by: Edward Welbourne <edward.welbourne@qt.io> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: BogDan Vatra <bogdan@kdab.com>
* Doc: Replace example file lists with links to code.qt.ioTopi Reinio2019-05-0338-0/+38
| | | | | | | | | | | | | | Instead of generating .html page for each file in an example project, generate links to code.qt.io, under the correct path and branch, where the user can browse the example source. Store all URLs under QT_INSTALL_DOCS/config where other qt5 submodules can access them. The repository name appears in the URL, so we cannot define a single URL for all modules. Task-number: QTBUG-74391 Change-Id: I63d4d6d2c352877797b1ee8e057d48c0cd789bff Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Merge remote-tracking branch 'origin/5.12' into 5.13Friedemann Kleint2019-05-271-0/+10
|\ | | | | | | Change-Id: Iaf6bd52972b562b9c91d9e93a988d26b0eb9d3b4
| * Qt Widgets: Document CMake macrosKai Koehne2019-05-161-0/+5
| | | | | | | | | | | | | | Task-number: QTBUG-72159 Change-Id: Ib9fdf852583964cf07c4d26e0a6c74f0058e29f1 Reviewed-by: Kevin Funk <kevin.funk@kdab.com> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
| * Qt Core: Document CMake macrosKai Koehne2019-05-161-0/+5
| | | | | | | | | | | | | | | | | | | | Document public macros in Qt5CoreMacros.cmake. This will replace the list in the current CMake Manual. Task-number: QTBUG-72159 Change-Id: I377412fe0c1d0a9b232162bbab88ac830d2cac80 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* | Merge remote-tracking branch 'origin/5.12' into 5.13Qt Forward Merge Bot2019-05-093-1/+56
|\ \ | |/ | | | | | | | | | | | | | | | | | | Conflicts: src/corelib/tools/qlocale_data_p.h (Regenerated by running the scripts in util/local_database/) src/gui/opengl/qopengltextureuploader.cpp Done-With: Edward Welbourne <edward.welbourne@qt.io> Done-With: Allan Sandfeld Jensen <allan.jensen@qt.io> Change-Id: I12df7f066ed0a25eb109f61c4b8d8dea63b683e2
| * Document how to use CMake on Qt Core, Qt GUI's central pagesKai Koehne2019-05-073-1/+56
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Add documentation on how to use a module from CMake, alongside the existing documentation about qmake. Separate generic info from module-specific examples, to make it possible to use one include file in all modules. While at it, also remove the mentioning of the central include; it is not something we should actively advocate anymore. Instead, the documentation of every class gives the correct include to use. Task-number: QTBUG-73058 Change-Id: I6b3c0e5ea218dd9c06a491c8fb799a7fcf42dd92 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* | Merge remote-tracking branch 'origin/5.12' into 5.13Qt Forward Merge Bot2019-04-261-6/+5
|\ \ | |/ | | | | Change-Id: I6ecf7074eda57ef4954fb3fdc7a6d1e8cd229340
| * Update external links to CMake documentationKai Koehne2019-04-251-6/+5
| | | | | | | | | | | | | | | | | | | | | | We don't support CMake version 2 anymore. Instead of just updating to a newer (but fixed) version let's link to the latest documentation. This might create a bigger risk that links get stale, but hopefully let people find always the latest information. Task-number: QTBUG-72159 Change-Id: I082de80cf9ee107b5d017ab8ad6369f2448b0e1b Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* | Merge remote-tracking branch 'origin/5.12' into 5.13Qt Forward Merge Bot2019-03-111-19/+0
|\ \ | |/ | | | | Change-Id: Iecdf00ca61d819bde532daa42f093860ec4a499e
| * Doc: Remove background colors from simplified offline CSSTopi Reinio2019-03-101-19/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | The simplified style needs to work for both light and dark themes in Qt Creator's help system. Background and text colors are already applied according to the active theme, this commit removes the rest of the hardcoded element colors that do not look good with a dark theme. Task-number: QTBUG-49417 Task-number: QTBUG-69327 Change-Id: Ib5ebe2755e98ca120f0500ab82713a37ec7199bd Reviewed-by: Kai Koehne <kai.koehne@qt.io>
* | Merge remote-tracking branch 'origin/5.12' into devLiang Qi2019-01-264-4/+4
|\ \ | |/ | | | | | | | | | | | | Conflicts: src/android/templates/AndroidManifest.xml tests/auto/widgets/styles/qstylesheetstyle/tst_qstylesheetstyle.cpp Change-Id: I4c9679e3a8ebba118fbf4772301ff8fde60455b9
| * Merge remote-tracking branch 'origin/5.12.1' into 5.12Qt Forward Merge Bot2019-01-234-4/+4
| |\ | | | | | | | | | Change-Id: Icebd151eae0cf9d400319a42573290d1a911ce26
| | * Bump copyright year to 2019Kai Koehne2018-12-184-4/+4
| | | | | | | | | | | | | | | | | | | | | | | | 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>
* | | Merge remote-tracking branch 'origin/5.12' into devQt Forward Merge Bot2019-01-211-0/+1
|\ \ \ | |/ / | | | | | | | | | | | | | | | Conflicts: .qmake.conf Change-Id: Ibfcb30053f3aacb8ec2ec480e146538c9bf440ea
| * | Documentation: Add \nullptr macro and use where applicableFriedemann Kleint2019-01-101-0/+1
| |/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Qt for Python users reading the documentation assume that int(0) can be passed for pointer parameters. Use the newly introduced \nullptr to disambiguate this. In a follow-up step, the \nullptr macro can be defined as None when generating the Qt for Python documentation. Task-number: PYSIDE-903 Change-Id: I3a45f87175a0668ab5f3f95f0aff409f7e3ef027 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> Reviewed-by: Christian Tismer <tismer@stackless.com> Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* | Merge remote-tracking branch 'origin/5.12' into devLiang Qi2018-10-253-815/+797
|\ \ | |/ | | | | | | | | | | | | | | Conflicts: src/corelib/animation/qpropertyanimation.cpp src/gui/image/qicon.cpp tests/auto/widgets/itemviews/qtableview/tst_qtableview.cpp Change-Id: I3698172b7b44ebb487cb38f50fd2c4a9f8a35b21
| * doc: Update online navigation header to match http://doc.qt.io/Tor Arne Vestbø2018-10-171-51/+18
| | | | | | | | | | | | Change-Id: I8154abc8cf2bb5895a75c4e41ff06cb99e4fedc5 Reviewed-by: Topi Reiniö <topi.reinio@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
| * doc: Update online CSSTor Arne Vestbø2018-10-163-762/+775
| | | | | | | | | | | | | | | | Copied from the CSS served by http://doc.qt.io/ Change-Id: Id37447e0f6de4a08a2632df862ae36f73d284814 Reviewed-by: Topi Reiniö <topi.reinio@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
| * doc: Update online HTML header URLsTor Arne Vestbø2018-10-161-3/+5
| | | | | | | | | | | | Change-Id: I2109f1a3113a724bfb6bc5a03b4c7b2d67f7e48c Reviewed-by: Topi Reiniö <topi.reinio@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* | Merge remote-tracking branch 'origin/5.12' into devQt Forward Merge Bot2018-09-291-0/+5
|\ \ | |/ | | | | Change-Id: I6083c3e61b7dbe188f83676f7e7bb268e5ccf2f3
| * Doc: Add a macro that expands to the Qt version (Major.Minor)Topi Reinio2018-09-251-0/+1
| | | | | | | | | | | | | | | | | | | | Versioning of some QML modules follows the Qt major and minor version exactly. Add a documentation macro that expands to the short version string to help automate the QML plugin documentation. Task-number: QTBUG-67818 Change-Id: I45e7a2a1adfd6a82b828222e49b1d02b7c05897e Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
| * Doc: Add a macro that returns the minor versionTopi Reinio2018-09-251-0/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Add a global QDoc macro \QtMinorVersion that expands into the minor version of Qt, or more specifically, the minor version contained in the QT_VER environment variable. The main use case for the new macro is to document the QML modules whose minor versions track the minor version of Qt: \qmlmodule QtQuick 2.\QtMinorVersion Task-number: QTBUG-67818 Change-Id: I2b4fcbb18de0f8f95718099309090017c237622f Reviewed-by: Martin Smith <martin.smith@qt.io>
* | Merge remote-tracking branch 'origin/5.12' into devQt Forward Merge Bot2018-09-2511-492/+0
|\ \ | |/ | | | | Change-Id: I65e4457a218f333161e9e72735b62fc821475f45
View Lorry Controller Status