summaryrefslogtreecommitdiffstats
path: root/src/corelib/doc
Commit message (Collapse)AuthorAgeFilesLines
* qt6_standard_project_setup: Don't enable AUTORCCJoerg Bornemann2022-01-261-2/+2
| | | | | | | | | | | We discourage using AUTORCC, so don't make it the default for our "standard project setup". Pick-to: 6.3 Task-number: QTBUG-87643 Task-number: QTBUG-100209 Change-Id: I2715ec561266bfed5ea4ac7722ab1f1c8b982788 Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
* Add documentation for the Android Multi-ABI related variablesAlexey Edelev2022-01-202-0/+95
| | | | | | | | | | | | | | | Document: QT_ANDROID_BUILD_ALL_ABIS - cache variable QT_ANDROID_ABIS - cache variable QT_PATH_ANDROID_ABI_<ABI> - cache variables ANDROID_ABIS - new argument of qt6_add_executable function Pick-to: 6.3 Task-number: QTBUG-99261 Change-Id: I7061065a6f329864ec9004ef41121f1225c5fc80 Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io> Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* QVersionNumber: port fromString() to QAnyStringViewMarc Mutz2022-01-181-2/+2
| | | | | | | | | | | | | | | | | We can handle the UTF-8 case by reinterpreting it as Latin-1. This way, the suffixIndex stays valid as a return value. As a drive-by, optimize away toLatin1() calls by using a QVLA. We really need a better way of converting UTF-16 -> L1 than qt_to_latin1()... [ChangeLog][QtCore][QVersionNumber] fromString() now takes QAnyStringView (was: QString, QStringView, QLatin1String) and a qsizetype pointer (was: int pointer). Change-Id: I86abaadba2792658fbf93ccd1e0b86e3302c697c Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
* Doc: Make QListIterator snippets more robustKai Köhne2022-01-177-19/+23
| | | | | | | | | | | qDebug() << i.next(); can become a NOOP if the code is compiled with QT_NO_DEBUG_OUTPUT. Pick-to: 5.15 6.2 6.3 Fixes: QTBUG-97535 Change-Id: I9085b40ac9b4de2bb06f16e03fd5100902b08d4f Reviewed-by: Marc Mutz <marc.mutz@qt.io>
* Add porting instructions for using binary JSONSona Kurazyan2022-01-131-31/+34
| | | | | | | | | | | Also move the instructions for using the Qt5Compat module to a separate section, since they repeat in a few places. Pick-to: 6.3 6.2 Fixes: QTBUG-99771 Change-Id: Ib9a45043bd9aa462a767780c0986ebfb9a7b948d Reviewed-by: Edward Welbourne <edward.welbourne@qt.io> Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
* Doc: Fix snippet to match actual QFileInfo behaviorKai Köhne2022-01-131-1/+1
| | | | | | | | | | The documentation was already updated in abfac029ceaf6c3199694a50, but the snippet still incorrectly suggested QFileInfo::size would report the actual size of an .lnk file on Windows. Pick-to: 5.15 6.2 6.3 Change-Id: I03b96b2efcb713fbc4dd30fc526e1209806bf5cf Reviewed-by: Oliver Wolff <oliver.wolff@qt.io>
* Doc: Replace "C:\Documents and Settings" pathsKai Köhne2022-01-122-4/+4
| | | | | | | | | | "C:\Documents and Settings" isn't a real path anymore since Windows Vista. Replace it by C:\Users, or - in the snippet for QDesktopServices that is for demoing a path with space - with C:\Program Files. Pick-to: 6.2 6.3 5.15 Change-Id: I1bef97b6482180a6467fffcd1d62d6c168bcb389 Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
* Document the State Machine Framework changes in the Core Migration GuideTamas Martinec2021-12-231-0/+6
| | | | | | | | | | | | Added section about having the State Machine Framework moved to its own module. Pick-to: 6.2 Pick-to: 6.3 Task-number: QTBUG-89285 Change-Id: I95d065230708d5b505d04309fd6ca21007d878dc Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Juha Vuolle <juha.vuolle@insta.fi>
* Doc: Use find_package(Qt6 REQUIRED COMPONENTS ...) idiomKai Köhne2021-12-094-4/+4
| | | | | | | | | | Using REQUIRED as a prefix instead of suffix works better with OPTIONAL_COMPONENTS, and is also the order in the CMake manual. Task-number: QTBUG-98867 Pick-to: 6.2 Change-Id: I1ab68408b95d8edf06272a3b9fceccd8d8e597fc Reviewed-by: Alexey Edelev <alexey.edelev@qt.io>
* CMake: Mark the new deployment API as being in Technical PreviewAlexandru Croitor2021-12-096-0/+22
| | | | | | | | Amends 22c92f39670d0376478cc2e73a17307508f86692 Task-number: QTBUG-98545 Change-Id: Ifaa7e4884f0eb1caa6d3d4906a2701f8fa5e43c2 Reviewed-by: Alexey Edelev <alexey.edelev@qt.io>
* CMake: Fix some of the CMake commands not using the right doc groupAlexandru Croitor2021-12-092-2/+2
| | | | | | | | Augments e0ecb0ded21082f4e00ee77411339009cb1294a4 Pick-to: 6.2 Change-Id: I4eea51b66ffa5ffe45faa3c51a4b65a526dd73e7 Reviewed-by: Alexey Edelev <alexey.edelev@qt.io>
* Add documentation for CMake deployment supportCraig Scott2021-12-0810-5/+717
| | | | | | Task-number: QTBUG-98545 Change-Id: Ifd5c0f4ce278c683bb0d3ba6a259ec14a7f24181 Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io>
* Repair parameter typeChunLin Wang2021-12-033-3/+3
| | | | | | | | | Fix the parameter types corresponding to the sample code and subclasses Fixes: QTBUG-98578 Pick-to: 6.2 Change-Id: I06e342ae1210ed53c5deec3e2711457cf2ac5b15 Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
* Document the example showing the benefits of using bindable propertiesSona Kurazyan2021-12-021-0/+14
| | | | | | | | | | | And mention the example in the bindable properties docs. Pick-to: 6.2 Task-number: QTBUG-97655 Change-Id: I676e90dbda66c2e718c7f6c2240fac608a8653df Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Ivan Solovev <ivan.solovev@qt.io> Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
* Doc: Replace use of \oldcode-\newcodeLuca Di Sera2021-11-251-6/+24
| | | | | | | | | | | The command-pair was recently deprecated. The replacement code should produce an output that is equal to the previous one. Task-number: QTBUG-98499 Change-Id: If26e0d85a174ebc3858b638c34d7f43637eab46d Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Add support for combining multiple QFuturesSona Kurazyan2021-11-201-0/+87
| | | | | | | | | | | [ChangeLog][QtCore] Added QtFuture::whenAll() and QtFuture::whenAny() functions, returning a QFuture that becomes ready when all or any of the supplied futures complete. Task-number: QTBUG-86714 Change-Id: I2bb7dbb4cdc4f79a7a4fd494142df6a0f93a2b39 Reviewed-by: Edward Welbourne <edward.welbourne@qt.io> Reviewed-by: Mårten Nordheim <marten.nordheim@qt.io>
* Docs: Move manifest and androiddeployqt docs to where code livesNicholas Bennett2021-11-191-1/+3
| | | | | | | | | | | Removed content describing androiddeployqt from deployment-android.html to androiddeployqt.html,the qdoc source now living in qtbase. Docs src locations added to the qtcore.qdocconf. Task-number: QTBUG-97842 Pick-to: 6.2 Change-Id: I94783520280098ce1ab35f335a644bea70b8131a Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io>
* Add missing QT_TRID_N_NOOP definitionLucie Gérard2021-11-181-0/+14
| | | | | | | | | | | | | Amends c74bd2b93, properly following up on qttools/bc47b5190. [ChangeLog][QtCore] Added missing QT_TRID_N_NOOP() macro. Lupdate actually recognizes it since Qt 5.12. Fixes: QTBUG-98277 Fixes: QTBUG-3945 Change-Id: I0ea15ceb49b2ead5c8bb40d2a55a0ae8577e8850 Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@gmx.de> Reviewed-by: Kai Koehne <kai.koehne@qt.io>
* QFuture: extend the docs to explain how to cancel continuation chainSona Kurazyan2021-11-151-0/+17
| | | | | | | Task-number: QTBUG-97582 Change-Id: Ib31d0dfb7a74bb88802a21c5875edd789e412529 Reviewed-by: Edward Welbourne <edward.welbourne@qt.io> Reviewed-by: Mårten Nordheim <marten.nordheim@qt.io>
* Add CMake variable to run androiddeployqt with --verbose argumentAlexey Edelev2021-11-021-0/+17
| | | | | | | Change-Id: Ib913e0471ef9c7efcc64c52de21a2e4c7d44e416 Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io> Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Extend documentation for bindable propertiesIvan Solovev2021-10-291-0/+17
| | | | | | | | | | | | | Extend the general property system page with a section on how to use bindable properties. Add some cross-references to improve the user experience. Task-number: QTBUG-97656 Pick-to: 6.2 Change-Id: I2520cdc168e3a8a66ea387e4ab717f4e0f969424 Reviewed-by: Edward Welbourne <edward.welbourne@qt.io> Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io> Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
* Doc: Enforce zero warnings for QtCore, QtGuiTopi Reinio2021-10-261-0/+3
| | | | | Change-Id: I7b39f9bf8d7bc9c9c5c21c4bd648a86281162740 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* QObjectComputedProperty docs: move example to snippetIvan Solovev2021-10-261-0/+37
| | | | | | | | | | | This patch amends 89a4c8d40d2ee1b8794dd7fcf80d226c5c87ba6c. It moves the code sample into a separate snippet file, which allows us to use Q_OBJECT macro in it without complaints from moc. Task-number: QTBUG-97656 Pick-to: 6.2 Change-Id: I368d8dd8c00dbbebd8a6bf3788be796c8ca4bce8 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
* Document QFutureWatcher::isFinished behavior changeMårten Nordheim2021-10-131-0/+4
| | | | | | | | | | in the Qt6 changes documentation Pick-to: 6.2 Change-Id: Ief45c145cbb9353455af39060a3fb444afe3f1b9 Reviewed-by: Edward Welbourne <edward.welbourne@qt.io> Reviewed-by: Eike Ziller <eike.ziller@qt.io> Reviewed-by: Sona Kurazyan <sona.kurazyan@qt.io>
* Doc: Fix usage of \summary macroTopi Reinio2021-10-1219-35/+35
| | | | | | | | | The macro takes only one parameter, sentences must be wrapped in {}. Pick-to: 6.2 Fixes: QTBUG-97441 Change-Id: I7177548a32a67d720c2b551d16c09d898b0fda51 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* QPoint: Don't claim that QPoint[F]::dotProduct() produces length squaredIevgenii Meshcheriakov2021-10-121-2/+2
| | | | | | | | | | | | | The documentation snippets name the result of dotProduct() "lengthSquared", but it is just a coincidence, not the property of dot product of two different points. Just name the result `dotProduct` without claiming any properties. Also fix the type of the result in the QPointF case. Fixes: QTBUG-94979 Change-Id: I4c337dd8335953489eac86c07a219c0a2d232369 Reviewed-by: Edward Welbourne <edward.welbourne@qt.io>
* corelib: Fix typos in documentationJonas Kvinge2021-10-123-3/+3
| | | | | | Pick-to: 5.15 6.2 Change-Id: I64d63af708bc6ddaabd12450eb3089e5077f849e Reviewed-by: Edward Welbourne <edward.welbourne@qt.io>
* corelib: Fix typos in source code commentsJonas Kvinge2021-10-121-1/+1
| | | | | | Pick-to: 6.2 Change-Id: Ic78afb67143112468c6f84677ac88f27a74b53aa Reviewed-by: Edward Welbourne <edward.welbourne@qt.io>
* Doc: Remove mentioning of CMake 3.9 minimum versionKai Köhne2021-10-071-2/+0
| | | | | Change-Id: Ia63bc7f305e673588ec57a7405ed5c0fdf3f5074 Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io>
* Doc: remove unnecessary newline in snippetKai Köhne2021-10-051-1/+0
| | | | | | Pick-to: 6.2 Change-Id: I6031fe8db971be4cbcaec8f1dc6fa7346edb601b Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Make it explicit when CMake API is definedKai Köhne2021-10-0516-0/+35
| | | | | | | | Task-number: QTBUG-96239 Pick-to: 6.2 Change-Id: Iaa99024f98f5422aa39f148a89594186b40344bf Reviewed-by: Edward Welbourne <edward.welbourne@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Add overview pages to CMake APIKai Köhne2021-10-0419-15/+85
| | | | | | | | | | | | | | So far the pages were only 'rooted' in the separate qtcmake documentation. Let them have a page per module too, so that it's easy to navigate. At the same time rename the cmake-macros-qtcore group to cmake-commands-qtcore. This will require a fixup in qtdoc repository. Pick-to: 6.2 Change-Id: Ifc09b27a6c220b5feab64686ca47c60d3342e71a Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Add summary to CMake commandsKai Köhne2021-10-0419-35/+35
| | | | | | | | | | | | For normal \page elements, \brief is just showing in the \generatelist or \annotatedlist commands. Make sure the description is also visible in the actual CMake command/variable/property page by defining a \summary macro. Pick-to: 6.2 Change-Id: I12bc854d547059a2f6309a5922bb0b2a36d4e41c Reviewed-by: Craig Scott <craig.scott@qt.io> Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* QMetaType: Expand and clean up converter/view function documentationFabian Kosmale2021-09-301-0/+101
| | | | | | | | | | | | | | This adds a few snippets to show how the functions can be used, and also removes workarounds for oldver versions of qdoc that weren't clang based - those workarounds also seem to have caused some bitrot. Remove documentation for an overload of registerMutableView that currently does not exist (for a member function with an ok parameter). Fixes: QTBUG-96963 Pick-to: 6.2 Change-Id: Ibc867d08bcacbc7add8c965df9864d6f339a5d54 Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
* Add docs for qt_extract_metatypes()Craig Scott2021-09-241-0/+78
| | | | | | | | | | | Also tidy up the inline TODO comments to reduce duplication and address some minor inconsistencies. Task-number: QTBUG-95712 Pick-to: 6.2 6.2.0 Change-Id: Ic0d27f3c0a356fd311bba95de967faaea05e0f0a Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io> Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
* Add docs for qt_set_finalizer_mode()Craig Scott2021-09-243-0/+116
| | | | | | | | | Task-number: QTBUG-95712 Pick-to: 6.2 6.2.0 Change-Id: Ie7b9282cfc6a27415db5e623a66317c9681c3991 Reviewed-by: Luca Di Sera <luca.disera@qt.io> Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io> Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
* Document qt_add_library() and update related docsCraig Scott2021-09-234-13/+186
| | | | | | | | | Task-number: QTBUG-95712 Pick-to: 6.2 6.2.0 Change-Id: Ib107110457380a2bb30876cf2c565f0c8e8c5e9c Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io> Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io>
* Add docs for qt_add_plugin()Craig Scott2021-09-232-5/+86
| | | | | | | | Task-number: QTBUG-95712 Pick-to: 6.2 6.2.0 Change-Id: Ifdc10c7714e91f6211a52bd5c46b3140485bbb43 Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io> Reviewed-by: Kai Koehne <kai.koehne@qt.io>
* Improve version-related docs in qglobal.cppEdward Welbourne2021-09-211-2/+2
| | | | | | | | | | Give a more pragmatic illustration for QT_DEPRECATED_BEFORE. Make various minor tweaks to wording, use slightly less antique versions in examples. Make usage of "runtime" standard in qglobal.cpp, at least, since "run-time" seems to be less used generally. Change-Id: I1db4950d0d0e97903b1586d98ecba75576493b1c Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
* Add docs for qt_allow_non_utf8_sources()Craig Scott2021-09-212-0/+55
| | | | | | | Task-number: QTBUG-95712 Pick-to: 6.2 6.2.0 Change-Id: Ie09785ced5b2bf8098ccff3467f32244f32f9195 Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
* Add docs for qt_disable_unicode_defines()Craig Scott2021-09-211-0/+53
| | | | | | | Task-number: QTBUG-95712 Pick-to: 6.2 6.2.0 Change-Id: I37a50d9e8a62c7d9c30014692d99ffe2eb9b90fb Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
* Encourage use of QT_VERSION_CHECK()Edward Welbourne2021-09-201-2/+2
| | | | | | | | | | | | Document that QT_VERSION should normally be compared against it, rather than raw hex, and mildly update the example versions used in docs. (Left the snippets testing old version, since the code in which the #if-ery is used might actually make sense for those versions.) Improve related documentation in the process. Change-Id: Id3e97f41bfb0f81a117cf7b3a3ccd5f244e2a99a Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
* Rewrite Qt Resource System overviewKai Köhne2021-09-1612-178/+332
| | | | | | | | | | | | | | | | | | | | | | | | Restructure the Qt Resource System page to make the content more accessible, and coherent: - Focus less on the .qrc file format, but the overall use cases - Treat CMake as first-class citizen - Make it more obvious when to use :/, and when qrc:/ Some details that were deemed unnecessary were removed: - details about the internal naming of the .cpp file when qmake is used. - References to QDir::addSearchPath() and the search path list were removed. They relate IMO only indirectly to the Qt resource system. - A lot of the explanation around Q_INIT_RESOURCE/Q_CLEANUP_RESOURCE were dubious at best. Pick-to: 6.2 6.2.0 Fixes: QTBUG-95126 Fixes: QTBUG-94977 Fixes: QTBUG-59394 Task-number: QTBUG-88044 Change-Id: I04b64f2366631b2106f047de121daf5fdb01073d Reviewed-by: Alexey Edelev <alexey.edelev@qt.io>
* Doc: Centralize RFC documentation-links in rfc.qdocLuca Di Sera2021-09-162-6/+1
| | | | | | | | | | | | | | | | | | | | In the effort of repairing broken links as per QTBUG-96127, a series of RFC links referring to `tools.ietf.org/html/*` were modified to point to the new address that the site redirected to. To simplify executing a similar task and to diminish the duplication of manually inserted urls, the already existing `rfc.qdoc` file, containing `\externalpage` commands directing to RFC locations, was enhanced with links to all RFCs that were mentioned in the current documentation, so as to aggregate this common category of links. All links pointing to a `ietf` domain inside QDoc documentation blocks were then changed to use the newly provided external-references. Task-number: QTBUG-96127 Pick-to: 6.2 Change-Id: I2a52eb6aa8c9e346f64ef1a627b039220d9f6c2a Reviewed-by: Mårten Nordheim <marten.nordheim@qt.io>
* Doc: Update link to RFC-4627Luca Di Sera2021-09-131-1/+1
| | | | | | | | | | | | | | | | | | The old `tools.ietf.org/html/*` web pages containing RFCs now redirect to `datatracker.ietf.org/doc/html/*`. While the redirection work, our script to catch broken links on dev-snapshots builds of the documentation doesn't handle redirection correctly, reporting it as broken. Both to appease the broken-links script and to avoid an unneccesary redirection the RFC link in `json.doc` was modified to point to the new address. Task-number: QTBUG-96127 Pick-to: 6.2 Change-Id: Ic0b0441fb298cfe2e282904e7e8d9155ab25091c Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Remove inline docs for qt_import_plugins() to avoid duplicationCraig Scott2021-09-101-0/+2
| | | | | | | | | | | | | | | Don't maintain two copies of the docs for qt_import_plugins() in separate places. Remove the inline docs because they are not the canonical ones that the user docs contain. Also remove the TODO and qml plugins. Those are now handled by a separate command, qt_import_qml_plugins(). Add a "see also" link to assist in discoverability. Task-number: QTBUG-95712 Pick-to: 6.2 6.2.0 Change-Id: I3bb872f77a1b57fd5f2f4fe1355625c47e44a351 Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
* Add documentation for the NO_DEFAULT option for qt_import_plugins()Craig Scott2021-09-101-1/+5
| | | | | | | Task-number: QTBUG-95712 Pick-to: 6.2 6.2.0 Change-Id: I3ba7fa52fa38c2ee1f9080f91894c36504a4f451 Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
* Update Qt5:: namespaced targets in snippets to versionless Qt::Craig Scott2021-09-101-4/+4
| | | | | | | | | | | | The docs for CMake commands all show the versionless commands as the primary name, with versioned commands added as a note. Use the same preference for targets for consistency and update the Qt5:: namespaces to Qt:: rather than Qt6::. Task-number: QTBUG-95712 Pick-to: 6.2 6.2.0 Change-Id: I6bf1929a11656f88e27bb5877e9521a3a651361e Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
* Remove unused qt5_... CMake command snippetsCraig Scott2021-09-101-38/+0
| | | | | | | Task-number: QTBUG-95712 Pick-to: 6.2 6.2.0 Change-Id: I92535fd96937638bb8997a63455ba5152055b72a Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
* Move some CMake commands out of tech preview statusCraig Scott2021-09-102-4/+0
| | | | | | | Task-number: QTBUG-95712 Pick-to: 6.2 6.2.0 Change-Id: I6739e5d2fb4716f40e99576a73f57bca51060e92 Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
generated by cgit v1.2.3 (git 2.25.1) at 2024-05-28 12:33:59 +0000