summaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Change doc snippet licenseLucie Gérard2024-02-071-1/+1
| | | | | | | | | | | | | According to QUIP-18 [1], all doc snippet files should be LicenseRef-Qt-Commercial OR BSD-3-Clause [1]: https://contribute.qt-project.org/quips/18 Task-number: QTBUG-121787 Change-Id: I6e5bc9d05a5d510cc07a15abafe2257034562510 Reviewed-by: Kai Köhne <kai.koehne@qt.io> (cherry picked from commit 1dbc57ad0c7bb0ca9ffeb931c836f6f9791db12f) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* Change license of .qdoc filesLucie Gérard2024-02-021-1/+1
| | | | | | | | | | | | According to QUIP-18 [1], all .qdoc files should be LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only [1]: https://contribute.qt-project.org/quips/18 Change-Id: I4559af21fc9069efa9bf0cbd29c5e86cfdac9082 Reviewed-by: Kai Köhne <kai.koehne@qt.io> (cherry picked from commit 865d0133fcb54c0e22f53dde71ebbca9cbcaf78e) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* Introduce QTP0003 which controls the BUILD_SHARED_LIBS impact on user projectsAlexey Edelev2024-02-011-0/+5
| | | | | | | | | | | | | | | | | | | | Since 6.7 we consider the BUILD_SHARED_LIBS when creating libraries using Qt CMake API. This change may affect the user projects that rely on the old strategy of selecting the default library type. To preserve the old behavior this change introduces the QTP0003 policy that allows user to control whether the BUILD_SHARED_LIBS should or shouldn't be considered in library creation process. The policy doesn't affect Qt repos, we assume that we want the NEW behavior by default. Fixes: QTBUG-121707 Change-Id: I4bcfbd8966839731624e3f7ef9e0d6bb2782ac50 Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> (cherry picked from commit 31b75303d7f9126dcc9bb0e94f0ea4ef1b9c0a71) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* QFile::moveToTrash: add documentation about run time and fail conditionsThiago Macieira2024-01-251-0/+5
| | | | | | | | | | | | | | | | | | | | All of the implementations will attempt to perform a filesystem rename, so the runtime is constant for a single file and possibly for a directory full of files too. The macOS and Windows implementations use the OS API so they run with slightly elevated privileges. That means they don't fail under normal conditions. The XDG implementation will fail if the file or dir being trashed resides on a volume which doesn't have an existing trash location for the current user and one such cannot be created either, or if the hardlinking/renaming fails (usually with EXDEV). Pick-to: 6.6 Change-Id: I76ffba14ece04f24b43efffd17abd67e20196f2b Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> (cherry picked from commit 6d1b4d574021bc2d036e61526b01a2dea5876b5b) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* Doc: Update copyright year to 2024Topi Reinio2024-01-224-4/+4
| | | | | | | | | | | | Update copyright year in documentation template and copy-notice paragraphs. Pick-to: 6.6 6.5 6.2 Change-Id: I0ff70bbd5925078e80e6799ac80cfc8e6e68a2a0 Reviewed-by: Andreas Eliasson <andreas.eliasson@qt.io> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> (cherry picked from commit 091096fed7c69b8c61b313dc1b3b6fe40d42e0b4) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* Allow configuring the qtbase documentation-only buildAlexey Edelev2024-01-171-1/+1
| | | | | | | | | | | | | | | Use the QT_SUPERBUILD procedure when configuring the qtbase documentation-only build. This only makes sense for qtbase since we disallow building it using existing Qt installation. Other repositories should be configured using qt-configure-module script from the existing Qt installation and simply run 'ninja docs'. Fixes: QTBUG-120485 Pick-to: 6.6 6.5 Change-Id: Iafed5c17bea5c61edc239f08045922497215fb73 Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io> (cherry picked from commit 02a556674f0b3f04de5ab09dca53ed8e86a8ba06) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* doc: add macro for QML Language Server product nameSami Shalayel2024-01-171-0/+1
| | | | | | | | | | | Add a macro for QML Language Server product name. Task-number: QTBUG-120980 Change-Id: I8b7196881a1c3777f975079c22ecbeb6f868f5a6 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io> (cherry picked from commit 4ec386eeeadfd9b6cd9e64d5907c3c20493a0b68) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* Doc: Adapt to changed names of positioning examplesKai Köhne2024-01-141-2/+2
| | | | | | | Change-Id: I053b8f47dd6a37c9ca49d73d5f0d8cdbc73f37b9 Reviewed-by: Ivan Solovev <ivan.solovev@qt.io> (cherry picked from commit 6b0a5fe93bb92205f0988c196251d4d2f36121e1) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* Doc: Remove dead links to Concentric Circle ExampleKai Köhne2024-01-141-1/+0
| | | | | | | | | | Amends 33254fb41f29b510d Pick-to: 6.6 Change-Id: I81fee9ba277fdc6f3609440ddcf69cf7c3924c70 Reviewed-by: Eirik Aavitsland <eirik.aavitsland@qt.io> (cherry picked from commit efcfda3d84d0fb7e4b3270a7d96b3b95db8d522c) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* Android: update NDKr26b and clang 17.0.2 to docsRami Potinkara2023-12-231-3/+3
| | | | | | | | | Fixes: QTBUG-117993 Change-Id: Ice205e0f472f09fcf60ad41f4daac2cdaf3e362a Reviewed-by: Rami Potinkara <rami.potinkara@qt.io> Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io> (cherry picked from commit 39290c508e2c7fa816c6f79b3eb284adc0cad3c0) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* Doc: Give offline-dark.css ".qmlextra" a visible text colorAlessandro Portale2023-12-211-1/+0
| | | | | | | | | | | | | | .qmlextra's text color #254117 is too dark. Let it inherit a better suited text color. Amends: 436467134e6087ec5a0e360e1837aac4da2ce9ca Pick-to: 6.6 6.5 Fixes: QTCREATORBUG-30117 Change-Id: Ia9e0567b0b00f2e7c1359ac85f10c72cece3c087 Reviewed-by: hjk <hjk@qt.io> (cherry picked from commit 7b27a5b137e9b874928cebf2740520a0d98df282) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* Android: add macros for common tools and sdk versionsAssam Boudjelthia2023-12-201-0/+16
| | | | | | | | | | | | | To make it more maintainable and keep the docs up-to-date, define most of the version numbers for various tools used in Qt Android dev environment. Task-number: QTBUG-115020 Change-Id: I92aa52398b7700e90a0ffd39a1c40bb7a17c3658 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io> (cherry picked from commit eef0d82a4c991e0ac8b2f250b439c48396678c23) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* Doc: Fix documentation issues for Qt CoreTopi Reinio2023-12-191-2/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Fix template arguments in \fn signatures for Qt::compareThreeWay() functions. * Fix template arguments in \fn signatures for QDebug::operator<<() functions. * Fix \sa links to specific overloads of QSpan functions. * Fix \sa links to specific overloads of QFileInfo::fileTime(). * Remove references to 'Custom Type Example' (example has been removed). * Fix linking to 'JSON Save Game' example. * Fix references to 'Queued Custom Type' example. * Fix linking to QCryptographicHash::Algorithm. * Fix linking to Qt Qml module. * Fix undocumented parameters in qHypot(). Change-Id: If9eb9978a14e147f003672a682972b319454c311 Reviewed-by: Luca Di Sera <luca.disera@qt.io> Reviewed-by: Thiago Macieira <thiago.macieira@intel.com> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> (cherry picked from commit 96740ea3fed8a7837dc282135661723858fff198) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* Update Sliders exampleVolker Hilsheimer2023-12-191-0/+0
| | | | | | | | | | | | | | | | | | | Simplify the "responsive layout" implementation. Just use a QBoxLayout with changing direction instead of repopulating a QGridLayout, and change the orientation of one set of sliders instead of creating two sets in a stacked layout. Simplify the resizeEvent() implementation accordingly. Update the documentation snippet text to match the code, and document the resizeEvent() override. Pick-to: 6.6 Fixes: QTBUG-119977 Change-Id: I73a1bb215c956fa283291ebf0ea45ff9a975c727 Reviewed-by: Axel Spoerl <axel.spoerl@qt.io> (cherry picked from commit f3fb89ba298e1741320d8bfac9cbd0d503373bff) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* Doc: Do not translate company and product names in footerKai Köhne2023-12-181-4/+4
| | | | | | | | Pick-to: 6.6 Change-Id: Iccd4ca02f5474763591bf11a3887ccf4e38a32be Reviewed-by: Paul Wicking <paul.wicking@qt.io> (cherry picked from commit 0bf7d64ebdff44586f9023e811b2b4fd3142ca57) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* Turn the "concentriccircles" example into snippets, update screenshotVolker Hilsheimer2023-12-141-0/+0
| | | | | | | | | | | | | | | The example has a lot of code and documentation, but in essence shows how to use float-based QPainter APIs and how to set a render hint. That is two lines of code, which we can show as snippets. Update the screenshot of the example with a higher-resolution version. Pick-to: 6.6 Fixes: QTBUG-119983 Change-Id: Iafcb813dff6ab8c269176f7994c95947ebf5e559 Reviewed-by: Eirik Aavitsland <eirik.aavitsland@qt.io> (cherry picked from commit 33254fb41f29b510d3d74dbaab60f0a67ef56d46) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* Doc: Add convenience macros for specifying C++ type ordering informationTopi Reinio2023-12-011-0/+14
| | | | | | | | | | | | | | | | | QDoc in Qt 6.7 introduced new commands for C++ type ordering, \compares and \compareswith .. \endcompareswith. The latter is a block command that allows defining a comparison category, a list of types the category applies to, and optional further information inside the command block. Introduce convenience macros that allow a single-word/single-line command to provide the category/types in cases where further information can be omitted. Task-number: QTBUG-104110 Change-Id: I850498c79bd6885906fbc58d0517d33f5a13cf4b Reviewed-by: Luca Di Sera <luca.disera@qt.io> Reviewed-by: Marc Mutz <marc.mutz@qt.io>
* Doc: Fix wrong markup in QStandardPaths::findExecutableKai Köhne2023-11-291-5/+5
| | | | | | Pick-to: 6.6 Change-Id: Ia9b9752a7d73b8695f2be227d7fe78e6da927a2e Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Refurbish the shaped clock exampleMatthias Rauter2023-11-172-0/+0
| | | | | | | | | | | | The shaped clock example has the appearance of the analog clock, which was refurbished with 619ec1a6406a8be7bfa9d96b9e693e7a3323d8dc. This change applies the refurbished design to the shaped clock. Task: QTBUG-118871 Pick-to: 6.6 Change-Id: Ibcfc8e9fb239a1c6f7ea685f6cab1e50b2060a53 Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
* Refurbish the clock exampleMatthias Rauter2023-11-131-0/+0
| | | | | | | Fixes: QTBUG-118871 Pick-to: 6.6 Change-Id: I0a1a6444cb381d49adbc39e73d7862c9cfe61dce Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
* Convert tooltips example to snippetsVolker Hilsheimer2023-10-271-0/+0
| | | | | | | | | The important bits from the example are ~10 lines of code, no need for building a poor-man's version of a graphics or item view. Pick-to: 6.6 Change-Id: I7874c66765c5b46230c92846ee3de1ee83f47e45 Reviewed-by: Oliver Eftevaag <oliver.eftevaag@qt.io>
* Rename the JSON Save Game Example to Saving a Game to FileEdward Welbourne2023-10-201-1/+1
| | | | | | | | | | | Partly because it also saves to CBOR, but also because our guidelines say to avoid using "Example" in the title. Pick-to: 6.6 6.5 Task-number: QTBUG-111228 Change-Id: Id858475a6b0474228cfe8044e188cc763f56e3a8 Reviewed-by: Topi Reiniö <topi.reinio@qt.io> Reviewed-by: Marc Mutz <marc.mutz@qt.io>
* Doc: QtCore: Fix documentation issuesTopi Reinio2023-10-021-2/+2
| | | | | | | | | | | | | | | * Fix references to Wait Conditions Example, Semaphores Example, and MIME Type Browser Example as they were renamed. * Rename 'Shared Memory' example as its title clashes with the title of another page (sharedmemory.html). src/corelib/global/qfloat16.cpp: * warning: Invalid '\relates' (already a member of 'qfloat16') Pick-to: 6.5 6.6 Change-Id: Ia28be8e3882a7ad1fadcdbd50a657705d58526bd Reviewed-by: Andreas Eliasson <andreas.eliasson@qt.io>
* Docs: Add macros for common Qt productsNicholas Bennett2023-09-111-0/+3
| | | | | | | | | | | | Added macros for Qt for Android Automotive, Qt Online Installer, and Qt Maintenance Tool. Task-number: QTBUG-116562 Pick-to: 6.2 6.5 6.6 Change-Id: I0ef3bc0fd6b1ddf94c8be2feed7cf5e691c4776f Reviewed-by: Topi Reiniö <topi.reinio@qt.io> Reviewed-by: Esa Törmänen <esa.tormanen@qt.io> Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
* Add StateLocation & GenericStateLocation to StandardLocationJonathan Ketchker2023-09-071-1/+3
| | | | | | | | | | | | | | | | | | | | | The latest XDG spec (0.8) defines XDG_STATE_HOME that does not exist in QStandardPaths::StandardLocation. Some Linux distributions clean XDG_CACHE_HOME on restart which makes XDG_STATE_HOME useful as a path for saving application state. This commit adds StateLocation and GenericStateLocation to serve as a StandardLocation for XDG_STATE_HOME for all platforms. This commit also updates docs and tests to fit the new changes. [ChangeLog][QStandardPaths] Added StateLocation & GenericStateLocation to StandardLocation Change-Id: I470602466c37f085062cc64d15ea243711728fa5 Reviewed-by: David Faure <david.faure@kdab.com> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
* Docs: Add a macro for documenting something as a technical previewNicholas Bennett2023-08-021-0/+4
| | | | | | | | | Adds a warning symbol. Adds a note to the brief string. Pick-to: 6.5 6.6 Change-Id: Ib036295bbcf7ab5eca7fd554fb2da836fedad8a0 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Introduce macro.qtpolicydeprecatedbehavior for Qt CMake PolicyAmir Masoud Abdol2023-07-101-0/+2
| | | | | | | | | Added a template that we can use instead of rewriting the message for every policy. Pick-to: 6.6 Change-Id: I13cc182244d5f092e3d5677664bc149c6b126da5 Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
* Doc: Move the warninglimit configuration to doc/globalTopi Reinio2023-06-292-1/+10
| | | | | | | | 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>
* Use a global value for warning limit when testing documentation in CITopi Reinio2023-06-271-0/+3
| | | | | | | | | | | | | | | | | | | 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>
* QtDoc Global: Add macros for Qt Design Studio in qtdocPranta Dastider2023-06-221-0/+10
| | | | | | | | | | | | Adding some Qt Design Studio macros for global qtdoc use. This would ensure flexibility for the documentation writing. Pick-to: 5.15 6.5 6.6 Task-number: QDS-10142 Change-Id: Id61a68d124aad1b8c8f9e17358fb5990efbab5de Reviewed-by: Topi Reiniö <topi.reinio@qt.io> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Move imagine/musicplayer to tests/manual/imagine/musicplayerJan Arve Sæther2023-06-211-1/+0
| | | | | | | | | imagine/automotive already demonstrate the imagine style Pick-to: 6.5 6.6 Task-number: QTBUG-108751 Change-Id: I8ed52242e3a522f934cef7bcb299ce8fbcbdb601 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
* Doc: Correct the expansion of the raisedaster macro for DocBookLuca Di Sera2023-06-141-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | QDoc allows code-expanding macros to be defined so that the user can abstract away common code in a simple to use command. Furthermore, macros allows for a different expansion based on the currently generated format so that format-specific requirements can be satisfied when required. When format specific expansions are provided, QDoc considers the resulting text as if it should be generated verbatim. The "\raisedaster" macro is used to generate an superscript asterisk. The macro is provided for both HTML and DocBook. As the macro has format-specific expansions, the expanded code will be read verbatim. Nonetheless, while the HTML expansion expands to actual HTML, the DocBook expansion expands to an equivalent QDoc code, which will not be generated correctly. To avoid the issue, the DocBook version of "\raisedaster" is modified so that it produces the correct DocBook code. Change-Id: I3a37838bda885af42f8d93b86ec08126d7146ff9 Reviewed-by: Topi Reiniö <topi.reinio@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Provide a DocBook version of the beginqdoc and endqdoc macrosLuca Di Sera2023-06-141-0/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | QDoc allows code-expanding macros to be defined so that the user can abstract away common code in a simple to use command. Furthermore, macros allows for a different expansion based on the currently generated format so that format-specific requirements can be satisfied when required. Due to a certain bug in QDoc, when generating the DocBook format, QDoc would expand an HTML specific macro definition when a DocBook specific one was not provided. As this bug is now being fixed, the DocBook format will lose some of the output that it was previously generating. For example, the "\beginqdoc" and "\endqdoc" macros are defined, for HTML, to expand to the beginning of block-comment text, "/*!" and ending of block-comment text, "*/". To avoid losing the usage of "\beginqdoc" and "\endqdoc`" when generating DocBook, an equivalent expansion of the macro is now provided for the DocBook format. Change-Id: I45fb54f1f56077771c091323a69fd63e09a910eb Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Stop writing host-specific paths to generated .index filesTopi Reinio2023-06-141-0/+3
| | | | | | | | | | 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>
* Doc: Add DocBook version of youtube macroLuca Di Sera2023-06-142-0/+16
| | | | | | | | | | | | | | | | | | | | | | | | | | | QDoc allows code-expanding macros to be defined so that the user can abstract away common code in a simple to use command. Furthermore, macros allows for a different expansion based on the currently generated format so that format-specific requirements can be satisfied when required. Due to a certain bug in QDoc, when generating the DocBook format, QDoc would expand an HTML specific macro definition when a DocBook specific one was not provided. As this bug is now being fixed, the DocBook format will lose some of the output that it was previously generating. For example, the "\youtube" macro is defined, for HTML, so that a youtube video can be embedded by reference. To avoid losing the usage of "\youtube" when generating DocBook, an equivalent version expansion of the macro is now provided for the DocBook format. Change-Id: Id74155f2c30b80b5f4490f8451cd8d00535806d6 Reviewed-by: Topi Reiniö <topi.reinio@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Global configuration: Remove obsolete contentTopi Reinio2023-06-081-4/+0
| | | | | | | | | Configuration aliases are no longer supported. Pick-to: 6.6 6.5 Change-Id: I5bb4e1fe6a861f3824d9832f88d2b89c3f1498fd Reviewed-by: Topi Reiniö <topi.reinio@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Require Qt module documentation to define qhp configurationTopi Reinio2023-06-081-0/+3
| | | | | | | | | | | 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>
* Move widgets Application example to manual testsAxel Spoerl2023-06-042-0/+0
| | | | | | | | | | | | | With 6e77da640aa84c1efe330d4a5224c9c7425ece57, the documentviewer demo's TxtViewer plugin has been fully documented in order to replace the Application example. This patch moves the application example to manual tests. Pick-to: 6.5 Change-Id: I67d975e478c7bc840613c8af1301a4eafe8f1a42 Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
* Remove the "classwizard" exampleVolker Hilsheimer2023-05-163-1/+0
| | | | | | | | | | | | | | It adds nothing new to what the trivial and license wizard examples show, other than a bunch of somewhat messy and outdated code to generate C++ code files based on the input. The example is referenced in a few parts of the documentation, but there are equivalent snippets in the trivial and license wizard examples, so point at those instead, and add some relevant API usage where needed. Pick-to: 6.5 Change-Id: If1ff57e775bad28920d9e019aeccae69d1f4d127 Reviewed-by: Axel Spoerl <axel.spoerl@qt.io>
* Convert "extension" dialog example into snippetsVolker Hilsheimer2023-05-162-0/+0
| | | | | | | Pick-to: 6.5 Task-number: QTBUG-108751 Change-Id: I8ca4e058b832674dc0c8b84024cb70a667ee8db4 Reviewed-by: Axel Spoerl <axel.spoerl@qt.io>
* Update screenshot exampleVolker Hilsheimer2023-05-151-0/+0
| | | | | | | | Refresh screenshot of the example, and remove "Example" word from title. Pick-to: 6.5 Change-Id: I88c00db5b25536c45622bc580a9da5aaf01610bc Reviewed-by: Liang Qi <liang.qi@qt.io>
* Doc: Add CSS styling and icon for 'technical preview' itemsTopi Reinio2023-05-105-2/+34
| | | | | | | | | | | | | | QDoc adds a 'Status' field to the table on top of type reference pages. One common status for Qt modules/types is 'Technical preview'. Add an icon that is displayed next to the status description, highlighting the fact that the type is in tech. preview and therefore subject to change. Pick-to: 6.5 Task-number: QTBUG-113026 Change-Id: Ibe6ca2a562cc7810fe27e7dcf514c711cd022894 Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Add reference location for positioning examplesKai Köhne2023-05-021-0/+1
| | | | | | Pick-to: 6.5 Change-Id: I4f58544cac439f2ad768032e3d54d5ab51fe0755 Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
* Examples doc: Remove not needed android tagBartlomiej Moskal2023-05-021-1/+0
| | | | | | | | | | | | | There are two examples for Camera in Multimedia module. One of them is using widgets, while the second one is QML based. In such case the QML example is preferred for Android platform. That is why only QML example should have android tag. This commit remove android tag from qtMultimedia Widget Camera example. Fixes: QTBUG-113238 Change-Id: I9d2c072fcc18e8e5a5a44a9a2da887a7b6660b46 Reviewed-by: Ville Voutilainen <ville.voutilainen@qt.io>
* Rid of 'special case' markersAlexey Edelev2023-04-131-1/+0
| | | | | | | | | | | It's unlikely we will ever use pro2cmake at this project stage, so it doesn't make any sense to keep the 'special case' markers in the CMake scripts. Remove them and replace with TODO where needed. Change-Id: I84290c20679dabbfdec3c5937ce0428fecb3e5a7 Reviewed-by: Amir Masoud Abdol <amir.abdol@qt.io> Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
* Doc: Fix \examplecategory macroTopi Reinio2023-04-121-1/+1
| | | | | | | | | | Argument passed to the \ingroup command should not be wrapped in braces as it's read as-is. Pick-to: 6.5 Task-number: QTBUG-111891 Change-Id: Ic759af37e8b7e9f60651103b395fdd7e630779c6 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Add \examplecategory macroPaul Wicking2023-04-031-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Examples in Qt's codebase must be tagged with specific categories such that Qt Creator can group them thematically. This can be done by way of using the `\meta category` construct in QDoc. At the same time, we want the generated documentation to group the examples by the same logic as in Qt Creator. Hence, QDoc was modified to implicitly add a group for each category that is used in a `meta category` invocation. By design, QDoc exposes ways to list groups to users, but no way to list the \meta command invocations. Letting QDoc implicitly add a group for categories passed to the \meta command as a side-effect, therefore breaks with the principle of least surprise and the single responsibility principle. An alternative solution makes use of QDoc's existing support for code generation through macros. This patch introduces the macro `\examplecategory` as a global macro throughout Qt to achieve the same effect as the aforementioned change to QDoc. The macro takes an argument enclosed in curly braces. This argument is the example category name. It's used as meta information in the manifest files consumed by Qt Creator, and added as the category group name for the QDoc side at the same time. The introduction of this macro allows reverting the change to QDoc itself, while maintaining feature parity for both Qt Creator and the generated content. Task-number: QTBUG-111891 Pick-to: 6.5 Change-Id: I311b98168253b45ac456ff3c1824db3d835191a9 Reviewed-by: Luca Di Sera <luca.disera@qt.io>
* Remove loopback network exampleMårten Nordheim2023-03-231-1/+0
| | | | | | | | | | It doesn't showcase anything interesting that other examples don't already show off. Pick-to: 6.5 Change-Id: Ie95c3ddb3ff52b3beab54bd6fa75fb75ae5c7ba5 Reviewed-by: Timur Pocheptsov <timur.pocheptsov@qt.io> Reviewed-by: Konrad Kujawa <konrad.kujawa@qt.io>
* docs: Remove map and runfunction exampleDennis Oberst2023-03-211-2/+0
| | | | | | | | | amends: fbb470b40b2c86a55751bf3099cc0424f66c7274 amends: de5e0422ca14ad1bc042889fa68772bf6912a215 Pick-to: 6.5 6.5.0 Change-Id: I04d4a60f7e5f7f0d149667d0e78ca56bac23280d Reviewed-by: Ivan Solovev <ivan.solovev@qt.io>
* Example: rename progressdialog to primecounter and modernize itDennis Oberst2023-03-211-1/+0
| | | | | | | | | | | | | The previous example finished way too quickly and provided no real value in regards to API understanding. Previously, QtConcurrent::map was used, which was also used in other examples. We are now using QtConcurrent::filterReduce to demonstrate other functionality. Task-number: QTBUG-111165 Pick-to: 6.5 6.5.0 Change-Id: Ibd6eb119d0711cddfe8b211d460e9d67d6ce95c3 Reviewed-by: Mårten Nordheim <marten.nordheim@qt.io> Reviewed-by: Ivan Solovev <ivan.solovev@qt.io>
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-13 12:21:51 +0000