summaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
...
* 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>
* Example: update wordcount exampleDennis Oberst2023-03-201-1/+1
| | | | | | | | | | | | | | Added a QFileDialog to let the user select a path. Before, the path was statically assigned with "../../" , which is not optimal. I also modified the findFiles function to check for text files in general and not only *.cpp and *.h files. Lastly the result of the word counting is now displayed on the console, as I think this is an informative output from this example. Task-number: QTBUG-111165 Pick-to: 6.5 6.5.0 Change-Id: Ie27c6acb4f79a78e3bef141edb92de08901fde71 Reviewed-by: Mårten Nordheim <marten.nordheim@qt.io>
* docs: Remove side panel and swipe to remove examplesSanthosh Kumar2023-03-081-2/+0
| | | | | | | | | | | Removed side panel and swipe to remove examples as part of patchset 3bc6f344a8f10699313c3e0c9236dd6945edd895 and updated docs to reflect that change. Fixes: QTBUG-110989 Pick-to: 6.5.0 Change-Id: I6241dd9842b1584e3dd25057591fe29eaa34d579 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
* Move anchor layout example to manual testsJan Arve Sæther2023-03-021-1/+0
| | | | | | Pick-to: 6.5 6.5.0 Change-Id: I9c9a9dbcdaf705a31208b80b71e978938a492142 Reviewed-by: Oliver Eftevaag <oliver.eftevaag@qt.io>
* Remove the 'sdi' exampleVolker Hilsheimer2023-03-021-0/+0
| | | | | | | | | | | It is essentially the same as the other mainwindow examples, showing how to create a text editor. The only special code here is the tiling of the different main windows, which - without any documentation or explanation - is neither very helpful, nor relevant in 2023. Pick-to: 6.5 Change-Id: I48b92b1cf057f586e0d2842d1c0a3312154e9a13 Reviewed-by: Axel Spoerl <axel.spoerl@qt.io>
* Move Weather Anchor Layout example to manual testsJan Arve Sæther2023-03-021-1/+0
| | | | | | Pick-to: 6.5 Change-Id: I8782a83b5c12b4f57bf9ef9063818cb124bddd56 Reviewed-by: Oliver Eftevaag <oliver.eftevaag@qt.io>
* Examples doc: Tag 'To Do List Example' for iOSDoris Verria2023-02-271-2/+14
| | | | | | | | | | | All QtQuickControls examples are marked for android by default. However, the To Do List example is iOS specific so don't include it. Add it to the list of iOS tags instead. Fixes: QTBUG-111426 Pick-to: 6.5 6.4 Change-Id: Ic89d6b40d263f81ed402a2064f2e44b2fa826940 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
* qdoc: Add *.webp as an default image suffixFriedemann Kleint2023-02-211-1/+1
| | | | | | | | | | | | qdoc does ignore image directories if no file with 'known' suffix is found. [ChangeLog][qdoc] *.webp has been added to the list of default image suffixes. Pick-to: 6.5 Change-Id: I49524ea13d14dd7e246401dec7deb2ba4e66cb07 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Delete references to deleted examplesMårten Nordheim2023-02-161-0/+0
| | | | | | | | | The bearer code hasn't been in Qt for some years. Pick-to: 6.5 6.4 6.2 Change-Id: Id69ad1ce5035a0970f3507d4b6ba4a5549bf1d6c Reviewed-by: Konrad Kujawa <konrad.kujawa@qt.io> Reviewed-by: Timur Pocheptsov <timur.pocheptsov@qt.io>
* Examples: move widgets/codeeditor into manual testsVolker Hilsheimer2023-02-091-0/+0
| | | | | | | | | | | | | It's not a very well written example, using (largely unneed) hacks to implement what it does. It's also misleading - the syntaxhighlighter example is a better showcase for building a useful code editor. Move it to manual tests. Fixes: QTBUG-111025 Pick-to: 6.5 Change-Id: I405d41688235bf3e9a08373e716769f26d02fec6 Reviewed-by: Eskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@qt.io>
* Move findfiles example into manual testsVolker Hilsheimer2023-02-091-0/+0
| | | | | | | | | | | | | | | | | | | | The example follows bad and outdated practices: - running time consuming and I/O heavy workload in the GUI thread - calling processEvents to keep the UI responsive - showing results only at the end of a search rather than continuously Perhaps this example can be rewritten at some point to apply modern practices (at least use a thread and emit signals), but it seems to have low overall educational value. Moving it to be a manual test for now. Fixes: QTBUG-111002 Pick-to: 6.5 Change-Id: Id630fd4599096448ea4f96bcbf977b11a039796f Reviewed-by: Axel Spoerl <axel.spoerl@qt.io> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
* Turn elidedlabel example into a code snippetVolker Hilsheimer2023-02-091-0/+0
| | | | | | | | | | | | The example is 90% boiler plate for subclassing QFrame and providing a bit of GUI to change the size of the label using sliders. The interesting bit is a block of 25 lines of code, so turn those into a snippet and add that to the QTextLayout overview documentation. Fixes: QTBUG-111011 Pick-to: 6.5 Change-Id: I6e97b2ea47b553c8d998ad185cfac006721ef7ee Reviewed-by: Eskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@qt.io>
* Doc: Update copyright year in the templateTopi Reinio2023-02-074-4/+4
| | | | | | | Pick-to: 6.2 6.4 6.5 Fixes: QTBUG-110271 Change-Id: I70ce5356941d2499a219ab9fb1875df23acda3dc Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* Remove "Analog Clock Window Example"Jan Arve Sæther2023-02-071-2/+0
| | | | | | | | | | | | This is almost exactly the same as the "Analog Clock" (widget) example. "Analog Clock Window Example" demonstrates: * How to render to a QWindow (covered by RasterWindow example) * QPainter and transformations (covered by Analog Clock example) * How to use QTimer (covered by Analog Clock example) Pick-to: 6.5 Change-Id: I7f20a29798830ed6345eca250e4139cb314cab84 Reviewed-by: Paul Olav Tvete <paul.tvete@qt.io>
* Fix analog clock example to adhere to guidelinesJan Arve Sæther2023-02-021-2/+2
| | | | | | | | Guidelines: https://wiki.qt.io/Qt6/Example-Guideline Pick-to: 6.5 Change-Id: I12c65ae11e7906fd2e9dfb449072199560488aed Reviewed-by: Oliver Eftevaag <oliver.eftevaag@qt.io>
* Remove wiggly exampleJan Arve Sæther2023-01-312-1/+0
| | | | | | | | | It demonstrates timerEvent() and some QFontMetrics There are other examples that demonstrates this Pick-to: 6.5 Change-Id: I4ad6f30c8ef93c995f980545ed88ab13b9aa9c7d Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
* Doc: Do ignore \since 5.xKai Köhne2023-01-311-2/+2
| | | | | | | | | | | We only support Qt 5.15 since a while, so the detailed information in which Qt 5 version a particular class, function, or enum was introduced is becoming less and less relevant. Pick-to: 6.5 Change-Id: I39bd579f23abc0ac84879e9bd22e6a97651ef7c3 Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io> Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: explicitly mention C++ when discussing linking to C++ librariesMitch Curtis2023-01-311-3/+4
| | | | | | | Fixes: QTBUG-108325 Pick-to: 6.2 6.4 6.5 Change-Id: I7282c8a8df0bf8f403a4e7a9d4512e7bdf6c9979 Reviewed-by: Kai Köhne <kai.koehne@qt.io>
* Adhere to https://wiki.qt.io/Qt6/Example-GuidelineJan Arve Sæther2023-01-261-1/+1
| | | | | | | | * Remove "Example" suffix in title Pick-to: 6.5 Change-Id: I5da311850ab8f725da363969d7a8d8a1a85f8d70 Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* Fix qt android notifier example name for qtdocAssam Boudjelthia2023-01-201-1/+1
| | | | | | | | Rename from QtAndroidExtras/Qt Notifier to QtCore/Qt Android Notifier. Task-number: QTBUG-110230 Change-Id: I18ad45ce85b57977f32af5fc735119df88f93144 Reviewed-by: Ville Voutilainen <ville.voutilainen@qt.io>
* Remove android tag from QtOpenGL examplesVille Voutilainen2023-01-201-2/+0
| | | | | | Task-number: QTBUG-110230 Change-Id: I6997c1c0eb91f4ee6ff9e9579a742c6617310267 Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io>
* Remove android tag from Widgets examplesVille Voutilainen2023-01-201-41/+1
| | | | | | Task-number: QTBUG-110230 Change-Id: Ic03fcafcf6a9beea3e8c847ede8eaff924b8788b Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io>
* Remove android tag from QuickControls1 examplesVille Voutilainen2023-01-201-5/+0
| | | | | | Task-number: QTBUG-110230 Change-Id: Ib97ce416c56de7dcb3a47013c539845bd9206f7a Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io>
* Doc: Add margins to all anchors in a translated pageVenugopal Shivashankar2022-12-121-0/+6
| | | | | | | | | | Google translate drops the space around the non-translatable inline text. This should ensure that inline anchors have extra margins. Change-Id: I1c204a9a27d0a39256ef04aa3f03ba1b8433aa54 Done-with: Topi Reinio <topi.reinio@qt.io> Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Change links from froglogic to qt domainKai Köhne2022-12-091-2/+2
| | | | | | Pick-to: 5.15 6.2 6.4 Change-Id: Ic249f8dfa168948eddc83f35314708ffb40e75b1 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Doc: Add a dark offline CSSEike Ziller2022-11-113-3/+777
| | | | | | | | | | Which can be used by Qt Creator and Assistant. Task-number: QTBUG-97125 Task-number: QTCREATORBUG-26557 Change-Id: I03e5ac0a15f84101c73887724693e9eb27670754 Reviewed-by: Topi Reiniö <topi.reinio@qt.io> Reviewed-by: Jarek Kobus <jaroslaw.kobus@qt.io>
* Adapt qdoc macros and documentation for DocBookThibaut Cuvelier2022-11-043-2/+35
| | | | | Change-Id: I91e380e7670964937d90e478029f367177bf339b Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Move i18n example to qttoolsKai Köhne2022-11-011-0/+0
| | | | | | | | Move i18n example out of qtbase. In qttools, it can use lrelease, avoiding the need to store .qm files in the repository. Change-Id: I8ba36a1372c2a743b809e3f7ea95a67825558f41 Reviewed-by: Tor Arne Vestbø <tor.arne.vestbo@qt.io>
* Add a shortcut editor exampleLaszlo Papp2022-10-251-0/+0
| | | | | | | | | | | | | | | Many applications offer shortcuts for quick interaction with the application. It is also common in such applications to offer a shortcut editor in the preferences or separately in a dialog. However, even though this is a fairly common use case for applications with more than a couple of shortcuts, there is no good and comprehensive official Qt example how this could be achieved. This change is an attempt to bridge the gap. Change-Id: Ic01a404e6157bda1b0a75a0b792cbfe5d910d48f Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* qdoc: improve \youtube documentation for DocBook imagesThibaut Cuvelier2022-10-051-3/+4
| | | | | | | | | | | The same kind of line is required for DocBook as HTML or QHP. This change makes that requirement clear. It was suggested by Nicholas Bennett in a change in existing configuration for this exact line. Change-Id: I664300f229bac9931c6f1ac4a08bd7c8c42bf37c Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>
* Examples doc: Tags fix for QtQuick examplesBartlomiej Moskal2022-09-191-1/+20
| | | | | | | | | | | | | | | | | | | | Four examples in QtQuick module had wrong tag in qdocconf file: -QQuickRenderControl D3D11 Example -Scene Graph - Direct3D 11 Under QML -Scene Graph - Metal Texture Import -Scene Graph - Metal Under QML The first two are specific to Windows. The other two are IOS specific. They were all marked as "android". This commit changed those tags to correct one. Pick-to: 6.4 6.4.0 6.3 Fixes: QTBUG-106436 Fixes: QTBUG-106438 Fixes: QTBUG-106439 Fixes: QTBUG-106469 Change-Id: I3d8d3cb54e4e552d7574c7c2f1d59437374c6446 Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>
* CMake: Add reference documentation for QT_IOS_LAUNCH_SCREENAlexandru Croitor2022-09-021-0/+3
| | | | | | | | | Amends 578f4ba00c9fce9af922c9924ca104bc47e50f03 Pick-to: 6.4 Task-number: QTBUG-104519 Change-Id: I02ea0694ead0e5b8c7a70a09cc14b51d8e374dd5 Reviewed-by: Jörg Bornemann <joerg.bornemann@qt.io>
* Doc: fix example repo URLMitch Curtis2022-09-011-1/+1
| | | | | | | | | | qtquickcontrols2 was merged into qtdeclarative in Qt 6.2. Fixes: QTBUG-105004 Pick-to: 6.2 6.3 6.4 Change-Id: Icbec8a74f1269b270be42b6a93930fb28d64af37 Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Change the license of all CMakeLists.txt and *.cmake files to BSDLucie Gérard2022-08-231-1/+1
| | | | | | | Task-number: QTBUG-105718 Change-Id: I5d3ef70a31235868b9be6cb479b7621bf2a8ba39 Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Jörg Bornemann <joerg.bornemann@qt.io>
* Add license headers to cmake filesLucie Gérard2022-08-031-0/+3
| | | | | | | | | | | | CMakeLists.txt and .cmake files of significant size (more than 2 lines according to our check in tst_license.pl) now have the copyright and license header. Existing copyright statements remain intact Task-number: QTBUG-88621 Change-Id: I3b98cdc55ead806ec81ce09af9271f9b95af97fa Reviewed-by: Jörg Bornemann <joerg.bornemann@qt.io>
* Move the docs for porting to QRegularExpression to a common placeSona Kurazyan2022-07-203-0/+241
| | | | | | | | | | | Copy them from QRegExp docs in qt5compat to doc/global/includes/corelib/port-from-qregexp.qdocinc, so that the porting docs can be included from both Qt 6 porting guide and qt5compat. Task-number: QTBUG-89702 Pick-to: 6.4 6.3 6.2 Change-Id: I616e2333f60f36e4851398479939fd062016748d Reviewed-by: Edward Welbourne <edward.welbourne@qt.io>
* Clean up qt-cpp-defines.qdocconfKai Köhne2022-07-201-216/+3
| | | | | | | | | | | | | | | | | | | Cpp.ignoretokens, Cpp.ignoredirectives, falsehoods are not used anymore by clang based qdoc. Most defines are not needed, either, because clang based qdoc will get these defined by scanning the normal headers. And QDOC, Q_CLANG_QDOC is actually set by qdoc itself. What's left is Q_GUI_LIB, Q_WIDGETS_LIB, which is used in headers modules to make some API conditionally available. Finally, there's QT_KEYPAD_NAVIGATION, which seems to be a Qt 3 thing, but still some documentation depending on it ;) Pick-to: 6.4 Change-Id: Ib9cf0debac8d569cc21271087168a46c0f8635ca Reviewed-by: Thiago Macieira <thiago.macieira@intel.com> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Hide weak overload template magic from documentationKai Köhne2022-07-131-1/+0
| | | | | | | | | | | | | | | | Hide the 'template magic' to implement Q_WEAK_OVERLOAD from the documentation. So far Q_WEAK_OVERLOAD void foo() lead to template <typename> void foo() in the generated documentation, which is arguably confusing to the uninitiated. And people interested in implementation details & exact overload resolution will arguably just read the .h files themselves. Fixes: QTBUG-104851 Pick-to: 6.4 6.3 6.2 5.15 Change-Id: I5e0b1b337b28e621e6a627241aa8037da0a879a7 Reviewed-by: Marc Mutz <marc.mutz@qt.io>
* Doc: Fix online macros for commercial templateTopi Reinio2022-06-211-0/+3
| | | | | | | | | | qt-module-defaults-online.qdocconf includes online-specific overrides for some of the documentation macros. This needs to happen also in the commercial template to have equivalent behavior. Pick-to: 6.4 6.3 Change-Id: I2ca3246fbf16cef502e8eada056df6e8db573d5d Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>
* Fix typos in docs and commentsKai Köhne2022-06-151-1/+1
| | | | | | | | | Found by codespell Pick-to: 6.4 Change-Id: Ie3e301a23830c773a2e9aff487c702a223d246eb Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io> Reviewed-by: Edward Welbourne <edward.welbourne@qt.io>
generated by cgit v1.2.3 (git 2.25.1) at 2024-04-26 15:08:47 +0000