summaryrefslogtreecommitdiffstats
path: root/doc/global
Commit message (Collapse)AuthorAgeFilesLines
* Offline documentation CSS: Remove external link icon from video linksTopi Reinio14 days1-0/+4
| | | | | | Pick-to: 6.1 Change-Id: I1fddad28399f83bfb8bfb7bbc0c4825907dfeb4d Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Remove styling for hyperlinks from the simplified offline styleTopi Reinio14 days1-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. Pick-to: 6.1 6.0 5.15 Fixes: QTBUG-32778 Change-Id: I51ca87f8a526a07a385e42a3c978712ac4d1e91b Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Offline CSS: Reduce excess vertical spacingTopi Reinio14 days1-9/+8
| | | | | | | Pick-to: 6.1 5.15 Fixes: QTBUG-89829 Change-Id: I0beb43fb2f40cbd1e5b36c95322f1a1530f5acf4 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Doc: Online CSS: Fix image captions overlapping images used in tablesTopi Reinio2021-02-091-0/+3
| | | | | | | Pick-to: 6.1 5.15 Fixes: QTBUG-90963 Change-Id: I15c7459246ed6dfa1ad85b732484770babeabfdc Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Update Qt Creator link targetsLeena Miettinen2021-02-011-157/+349
| | | | | | | | | | | - Add links to new topics - Remove links to obsolete topics - Update changed topic titles (might break links in module docs) - Fix HTML file name of the Creating a Mobile Application topic Change-Id: I8f06171946d85ed0fbfd457ed115f41cb5a9e2d0 Reviewed-by: Nico Vertriest <nico.vertriest@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Bump copyright year to 2021Kai Köhne2021-01-254-4/+4
| | | | | | Change-Id: I18a9c2de391ca51655148b2e3cc9abdfbb8ddbcf Reviewed-by: Tarja Sundqvist <tarja.sundqvist@qt.io> Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io>
* Doc: Add partial documentation for CMake API (tech preview)Craig Scott2021-01-111-0/+7
| | | | | | | | | | | | | | There are still other parts of the CMake API that are not yet documented. This change only addresses qt_add_executable() and the Android-related commands it uses. Fixes: QTBUG-88839 Task-number: QTBUG-84482 Pick-to: 6.0 Change-Id: I761b5ce908d1f62284baabe2d414cd37a0efe83d Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io>
* Offline docs: Improve styling of unordered lists and external linksTopi Reinio2020-12-221-10/+24
| | | | | | | | | | | Use list-style-type correctly and replace background-image with ::before content for external link icons. Pick-to: 6.0 Fixes: QTBUG-89470 Fixes: QTBUG-89471 Change-Id: Ib11a45baf5e92565b22e21f3bd1a929cbbbef608 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Fix typo in external-resources.qdocAndreas Buhr2020-12-071-1/+1
| | | | | | | | | C++ comment was terminated by "/" instead of "*/" Task-number: QTBUG-88533 Pick-to: 6.0 Change-Id: I560b69602856009509781e56df36fee5879a297f Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
* Fix broken link to Zstandard libraryAndreas Buhr2020-12-041-0/+5
| | | | | | | | | | | | The old link zstd.net is not working any more. Zstandard is now at http://facebook.github.io/zstd/. To ease maintenance in the future, those links now point to "Zstandard Site" which is maintained in external-resources.qdoc. Task-number: QTBUG-88533 Pick-to: 6.0 Change-Id: Ic8f067fd5d7ce1a088d0272797fca98fd506a26e Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
* Doc: Make \youtube macro work with litehtml help backendTopi Reinio2020-12-013-3/+8
| | | | | | | | | | | | | Unlike the QTextBrowser backend, litehtml does not render elements inside <iframe> correctly. This prevented external links to YouTube from working in offline documentation. Move the <iframe> to a macro override specific to online doc builds. Pick-to: 6.0 6.0.0 Fixes: QTBUG-88975 Change-Id: Iff7828ddeed353620eaa9ac669a3e0c03749daa2 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Add thumbnail for Widgets Gallery ExampleTopi Reinio2020-11-301-0/+1
| | | | | | | | | | The example won't show up in Qt Creator's Welcome mode without either an \image or a generic thumbnail. Add the latter for now. Pick-to: 6.0 Fixes: QTBUG-88970 Change-Id: Id5ec236ef4760e678921bc2a90608d66ac35394d Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Fix reference to Qt5 CMake packageKai Koehne2020-11-191-1/+1
| | | | | Change-Id: I5abd63727d6578cb30c6d11228777e4bd9bf91b7 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* doc/global: Remove references to Qt 5 in commentsKai Koehne2020-11-193-6/+6
| | | | | Change-Id: I15d91e2f593551879b1b3b5adf58c536abf8467b Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Add external link to conan.ioKai Koehne2020-11-161-0/+5
| | | | | | | | We don't use it yet in qtbase, but will need it in various other sub-modules, so it's arguably better to maintain it here. Change-Id: I5c10c9b34cafd435251918280ad0405189900337 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Add macro to exclude examples from CreatorPaul Wicking2020-10-271-0/+3
| | | | | | Done-with: Topi Reinö <topi.reinio@qt.io> Change-Id: I069214e3139c8b9993b5b8f86e4b5cda1dcc2bfd Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Remove usage of deprecated QStandardPaths::DataLocationKarsten Heimrich2020-10-231-1/+1
| | | | | | | | | * Rearrange the documention to match the enumeration order. Fixes: QTBUG-87037 Change-Id: Iad001351e0f309e694b8bbd503813017e6586a21 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io> Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
* doc: Fix table bottom marginTor Arne Vestbø2020-10-231-2/+2
| | | | | | | | | | It was way too small, and should match the margins for other content such as paragraphs, so that an inline table in between two paragraphs has a balanced spacing. Change-Id: I2adb434ac7773e9796199f40d5318368ca380aca Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Add link to Qt for Python as external pageJerome Pasion2020-10-201-0/+5
| | | | | | | | Qt for Python can be linked with \externalpage QDoc command Task-number: QTBUG-87158 Change-Id: I68acc028f89af09cbd069e098a0fbbfa72234cdc Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* Add Qt Marketplace link as an external pageJerome Pasion2020-10-121-0/+5
| | | | | | | | Link to the website with the QDoc \l command Task-number: QTBUG-87158 Change-Id: I1ae93f4ecf917dbb06e4ebd1eb1ca1b8fe31562b Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* Add links to Qt 3D Studio and Qt Design StudioJerome Pasion2020-10-081-0/+10
| | | | | | | | Enables linking to them using QDoc \l command Task-number: QTBUG-85517 Change-Id: I23073a5c7b2f06a8ecf66116c538dcd3fff08f61 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Purge Q_{STDLIB,COMPILER}_UNICODE_STRINGSEdward Welbourne2020-09-141-4/+0
| | | | | | | | | These were now always defined, hence redundant. Leave the #define in place so that we can verify we actually do always define it, in a #else of an existing #if check on it. Change-Id: Iea4c3dbc8f9982268bcf81da5ef17fe2ebf5c462 Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
* Doc: Fix documentation warnings for Qt GUITopi Reinio2020-08-281-0/+1
| | | | | | | | | | | | * Drop deprecation warnings for now-dropped items * Use the 'qt6' define and a new \nothing doc macro to conditionally document items on Qt 6 * Add a custom module header for docs that pulls in also Vulkan headers * Add \internal command for internal classes/functions * Move QtGUI-related code snippets from widgets to gui docs Change-Id: Ieb386b96631a49568d09059906d307c45c01d93a Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Move QStateMachine from QtCore to QtScxmlKarsten Heimrich2020-08-241-5/+0
| | | | | | Task-number: QTBUG-80316 Change-Id: I2ee74110fd55e94d86321d3b3dc5bb8297424ed4 Reviewed-by: Maurice Kalinowski <maurice.kalinowski@qt.io>
* 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>
* QString: add char8_t overload of fromUtf8()Marc Mutz2020-06-231-0/+1
| | | | | | | | | | | | | Use the overload-with-template trick from P1423 to avoid ambiguities when existing callers pass 0 or nullptr. Add a qdoc-ignored macro to hide the fact that the overload is a template. [ChangeLog][QtCore][QString] Added char8_t overload of fromUtf8(). Change-Id: Iaa2d365bfa161ef36cc73fa3bad50aabf34d01db Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
* Move QTextCodec support out of QtCoreKarsten Heimrich2020-06-201-3/+0
| | | | | | | | | | * Assume UTF-8 on all Unix like systems * Export some functions to be able to compile QTextCodec once moved to Qt5Compat. Task-number: QTBUG-75665 Change-Id: I52ec47a848bc0ba72e9c7689668b1bcc5d736c29 Reviewed-by: Lars Knoll <lars.knoll@qt.io>
* Doc: Update global documentation config for Qt 6Topi Reinio2020-06-085-19/+15
| | | | | | | | | | | | | | - 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>
* 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 Pick-to: 5.15 Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* 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 Pick-to: 5.15 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Remove last remainings of Qt Quick 1 importsKai Koehne2020-05-251-5/+0
| | | | | | | amends e1fd6074935cd0be0 Change-Id: I4587ae287635bc9718325a24bee728f1c1938978 Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io>
* Merge remote-tracking branch 'origin/5.15' into devQt Forward Merge Bot2020-04-221-0/+16
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | Conflicts: src/widgets/widgets/qabstractbutton.cpp src/widgets/widgets/qbuttongroup.cpp src/widgets/widgets/qbuttongroup.h src/widgets/widgets/qsplashscreen.cpp tests/auto/widgets/widgets/qbuttongroup/tst_qbuttongroup.cpp tests/benchmarks/opengl/main.cpp Needed update: src/plugins/platforms/cocoa/CMakeLists.txt Change-Id: I7be4baebb63844ec2b3e0de859ca9de1bc730bb5
| * 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>
* | Merge remote-tracking branch 'origin/5.15' into devQt Forward Merge Bot2020-04-082-20/+7
|\ \ | |/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Conflicts: examples/opengl/doc/src/cube.qdoc src/corelib/global/qlibraryinfo.cpp src/corelib/text/qbytearray_p.h src/corelib/text/qlocale_data_p.h src/corelib/time/qhijricalendar_data_p.h src/corelib/time/qjalalicalendar_data_p.h src/corelib/time/qromancalendar_data_p.h src/network/ssl/qsslcertificate.h src/widgets/doc/src/graphicsview.qdoc src/widgets/widgets/qcombobox.cpp src/widgets/widgets/qcombobox.h tests/auto/corelib/tools/qscopeguard/tst_qscopeguard.cpp tests/auto/widgets/widgets/qcombobox/tst_qcombobox.cpp tests/benchmarks/corelib/io/qdiriterator/qdiriterator.pro tests/manual/diaglib/debugproxystyle.cpp tests/manual/diaglib/qwidgetdump.cpp tests/manual/diaglib/qwindowdump.cpp tests/manual/diaglib/textdump.cpp util/locale_database/cldr2qlocalexml.py util/locale_database/qlocalexml.py util/locale_database/qlocalexml2cpp.py Resolution of util/locale_database/ are based on: https://codereview.qt-project.org/c/qt/qtbase/+/294250 and src/corelib/{text,time}/*_data_p.h were then regenerated by running those scripts. Updated CMakeLists.txt in each of tests/auto/corelib/serialization/qcborstreamreader/ tests/auto/corelib/serialization/qcborvalue/ tests/auto/gui/kernel/ and generated new ones in each of tests/auto/gui/kernel/qaddpostroutine/ tests/auto/gui/kernel/qhighdpiscaling/ tests/libfuzzer/corelib/text/qregularexpression/optimize/ tests/libfuzzer/gui/painting/qcolorspace/fromiccprofile/ tests/libfuzzer/gui/text/qtextdocument/sethtml/ tests/libfuzzer/gui/text/qtextdocument/setmarkdown/ tests/libfuzzer/gui/text/qtextlayout/beginlayout/ by running util/cmake/pro2cmake.py on their changed .pro files. Changed target name in tests/auto/gui/kernel/qaction/qaction.pro tests/auto/gui/kernel/qaction/qactiongroup.pro tests/auto/gui/kernel/qshortcut/qshortcut.pro to ensure unique target names for CMake Changed tst_QComboBox::currentIndex to not test the currentIndexChanged(QString), as that one does not exist in Qt 6 anymore. Change-Id: I9a85705484855ae1dc874a81f49d27a50b0dcff7
| * 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>
* | Merge remote-tracking branch 'origin/5.15' into devLars Knoll2020-03-041-78/+97
|\ \ | |/ | | | | Change-Id: I99ee6f8b4bdc372437ee60d1feab931487fe55c4
| * 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.15' into devLiang Qi2020-02-131-1/+6
|\ \ | |/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Conflicts: examples/widgets/graphicsview/boxes/scene.h src/corelib/Qt5CoreMacros.cmake src/corelib/Qt6CoreMacros.cmake src/network/ssl/qsslsocket.cpp src/network/ssl/qsslsocket.h src/platformsupport/fontdatabases/windows/qwindowsfontenginedirectwrite.cpp src/testlib/CMakeLists.txt src/testlib/.prev_CMakeLists.txt tests/auto/corelib/tools/qscopeguard/tst_qscopeguard.cpp Disabled building manual tests with CMake for now, because qmake doesn't do it, and it confuses people. Done-With: Alexandru Croitor <alexandru.croitor@qt.io> Done-With: Volker Hilsheimer <volker.hilsheimer@qt.io> Change-Id: I865ae347bd01f4e59f16d007b66d175a52f1f152
| * 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/dev' into merge-devLeander Beernaert2020-01-246-41/+172
|\ \ \ | |/ / | | | | | | Change-Id: I31b761cfd5ea01373c60d02a5da8c33398d34739
| * | 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>
* | Merge remote-tracking branch 'origin/dev' into wip/cmakeLeander Beernaert2019-11-191-0/+6
|\ \ | |/ | | | | Change-Id: Ifecc2d9db396d783124df8567553ba5f846f30bb
| * 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/dev' into wip/cmakeAlexandru Croitor2019-10-141-2/+46
|\ \ | |/ | | | | Change-Id: I4a78428a8ea273b6960792e3b8043f816fa37fcf
| * Merge remote-tracking branch 'origin/5.13' into 5.14Friedemann Kleint2019-09-091-2/+46
| |\ | | | | | | | | | | | | | | | | | | 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>