summaryrefslogtreecommitdiffstats
path: root/doc/global
Commit message (Collapse)AuthorAgeFilesLines
...
* 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>
* 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-311-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>
* 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>
* 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>
* Doc: Fix typo in the online documentation templateTopi Reinio2022-05-311-1/+1
| | | | | | Pick-to: 5.15 6.2 6.3 Change-Id: I15e6db96722f5139f35dcffe70f796c4d7c17327 Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* Doc: Link to page documenting Qt trademarks in the copyright footerTopi Reinio2022-05-302-6/+6
| | | | | | | | | | Use an unversioned link to the online documentation, ensuring we link to the latest version of this page. Pick-to: 6.3 6.2 5.15 Task-number: QTBUG-102787 Change-Id: I285356687a3873fb861a54d003185f2b751c1b72 Reviewed-by: Kai Koehne <kai.koehne@qt.io>
* Use SPDX license identifiersLucie Gérard2022-05-169-234/+18
| | | | | | | | | | | | | Replace the current license disclaimer in files by a SPDX-License-Identifier. Files that have to be modified by hand are modified. License files are organized under LICENSES directory. Task-number: QTBUG-67283 Change-Id: Id880c92784c40f3bbde861c0d93f58151c18b9f1 Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Lars Knoll <lars.knoll@qt.io> Reviewed-by: Jörg Bornemann <joerg.bornemann@qt.io>
* Doc: Fix syntax in \tab macro exampleAndreas Eliasson2022-05-091-4/+4
| | | | | | Pick-to: 6.3 Change-Id: I490ecc3a810b911f9e6b242fc01f5a03800e9bc9 Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* Doc: Fix padding inside tab contentAndreas Eliasson2022-05-091-3/+8
| | | | | | | | | | | The previously defined padding for the tab content was overwritten to 0 by a more specific css selector. In addition, code snippets should not have any extra padding, hence the :not(.pre) css selector. Pick-to: 6.3 Change-Id: I8f331924c5d01c8971660bb7a5b3aad25e3dee8a Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* Fix alignment of next/prev links in offline styleKai Köhne2022-05-061-1/+1
| | | | | | | | | | With the old value, they were placed above the header bar. Moving them a few pixels below looks less broken. Pick-to: 6.2 6.3 5.15 Change-Id: Iddd9d5e0b5c199fe35a9c8b8a7cac9a472901a21 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Fix typo in the HTML tabs configVenugopal Shivashankar2022-04-251-1/+1
| | | | | | Pick-to: 6.2 6.3 Change-Id: I00fad2e1e686f977bd508109c1a6a5d064d7a3d6 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Add a marker for post-C++17 APIs in exported classesGiuseppe D'Angelo2022-04-111-0/+1
| | | | | | | | | | | | | | | | | | | | | | | MSVC will export any function in an exported class, including inline ones. Conversely: client code calling inline functions in imported classes will end up simply calling the symbol of the function, even if the function is fully inline. This is a problem for adding post-C++17 APIs in Qt. Such APIs are added as inline functions protected by feature-macro tests, so that both Qt and client apps can use any C++ version they want (any combination works). However, if we add a function using post-C++17 API to an exported class, then the combination "Qt built in C++17" + "client built in post-C++17" won't work any more. The client will expect the symbol for that function to be exported by Qt, but Qt won't have it (built in C++17). As a workaround, add a marker that turns these functions into "faux templates", like Q_WEAK_OVERLOAD does. Change-Id: I2adab81e3129c881c5a8e0772948b176fa4db1b6 Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
* Doc: Add qdoc macro for tabbed contentVenugopal Shivashankar2022-04-053-0/+117
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The macro enables tabbed content in the online style only. It's usage must be gaurded with a conditional block as shown in the following example to handle the offline style usecase: \if(onlinedocs) \tab {build-qt-app}{tab-cmake}{CMake}{selected} \tab {build-qt-app}{tab-qmake}{qmake}{} \tabcontent {tab-cmake} \else \section1 Using CMake \endif CMake-specific instructions go here \if(onlinedocs) \endtabcontent \tabcontent {tab-qmake} \else \section1 Using qmake \endif qmake-specific instructions go here \if(onlinedocs) \endtabcontent \endif Pick-to: 6.2 6.3 Change-Id: I02d50c057280a9ffea913642284e67ddcda7aa94 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Document what QtTest's various loggers doEdward Welbourne2022-03-221-0/+20
| | | | | | | | | Provide basic (internal) documentation of each logging class and link the command-line documentation to pages relevant to the formats not defined by Qt. Change-Id: I3251dd1304203c6ab87dfe1f2dec0e9787ab69f8 Reviewed-by: Tor Arne Vestbø <tor.arne.vestbo@qt.io>
* Doc: Use \QtVersion macro to display correct version in code snippetTopi Reinio2022-03-141-2/+2
| | | | | | | | Pick-to: 6.3 Fixes: QTBUG-100770 Change-Id: Iec0e91bfb98781e63e5379bd0aa67d37df7c6cac Reviewed-by: Luca Di Sera <luca.disera@qt.io> Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* QProcess/Doc: update the information on how the program is foundThiago Macieira2022-03-101-0/+5
| | | | | | Pick-to: 5.15 6.2 6.3 Change-Id: I54f205f6b7314351b078fffd16d05b1eecb24544 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Document use of android:allowNativeHeapPointerTagging in the manifestAssam Boudjelthia2022-03-051-0/+4
| | | | | | | | | | | Document the tag for more clarity on why it's needed, and for what platforms. Pick-to: 6.2 6.3 Task-number: QTBUG-97009 Task-number: QTBUG-91150 Change-Id: Ie4522fb582583be07270d3cdbf83992897b51669 Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>
* Doc: Add \include snippets with optional parametersAndreas Eliasson2022-02-281-1/+36
| | | | | | | | | | | | | | | | | | There are many different wordings for how to use the module across the module landing pages. The goal here is to provide consistent wording and code formatting, which can be used across all landing pages. The style and wording is based on what has been implemented in the Qt CoAP module landing page. This is the syntax in a qdoc file: \include {module-use.qdoc} {<snippet-id>} {<argument1>} Inside qdocinc, you can then get the value of the argument1 using the parameter \1. Task-number: QTBUG-100369 Change-Id: Ib25e509e119008157e69db629eb011e5a9074022 Pick-to: 6.3 Reviewed-by: Kai Koehne <kai.koehne@qt.io>
* wasm: move user configurable settingsLorn Potter2022-02-231-0/+2
| | | | | | | | | | | Both INITIAL_MEMORY and PTHREAD_POOL_SIZE are settings users can change, they are not interface settings. Fixes: QTBUG-100693 Pick-to: 6.3 6.2 Change-Id: Ie1547c7f52c9fe109a313260616705728024b6b8 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: David Skoland <david.skoland@qt.io>
* qglobal: add a way to selectively export in Qt 6 XOR Qt 7Thiago Macieira2022-02-091-1/+3
| | | | | | | | | Because at least one compiler *cough*MSVC*cough* is unable to dllexport a method that is in a dllexport'ed class. Change-Id: I54f205f6b7314351b078fffd16d06b4e6ef0c086 Reviewed-by: Marc Mutz <marc.mutz@qt.io> Reviewed-by: Edward Welbourne <edward.welbourne@qt.io>
* Doc: Update cmake documentation linkKai Köhne2022-02-091-1/+1
| | | | | | | | http://www.cmake.org/cmake/help/documentation.html works, but is nowadays just a redirect. Change-Id: Ic443eb5e16ef92f523391bcb94cd7763d0e39151 Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>
* Doc: State Qt versions for when CMake commands etc. were introducedJoerg Bornemann2022-02-011-0/+4
| | | | | | | | | | | | | | | | | | | Introduce the qdoc macros \cmakecommandsince, \cmakepropertysince, and \cmakevariablesince that insert a paragraph akin to the \since context command. Example: \cmakecommandsince 6.3 produces the paragraph This command was introduced in Qt 6.3 The macro text is wrapped in \n\n to ensure that we always generate a new paragraph. Pick-to: 6.2 6.3 Task-number: QTBUG-100212 Change-Id: Id5c8e8812e6b0b915674d108a0e775091e9eacd8 Reviewed-by: Kai Koehne <kai.koehne@qt.io>
* Doc: Update Notepad tutorialLeena Miettinen2022-01-312-2/+68
| | | | | | | | | Update to use Qt Creator 7.0 and CMake as the build system. Fixes: QTBUG-100075 Pick-to: 6.3 Change-Id: I71e1d1446a2c79c98423ca5d4427b4b4eb00021b Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* Prevent repeated instantiations of some qRegisterNormalizedMetaType<>s [1/N] ↵Marc Mutz2022-01-211-0/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | (QtGui) Create macros that wrap the magic developed in 7d63efc16f65f98c657caa90e0d7e9b72a879ade and apply it to all Q_DECLARE_METATYPE invocations that show up in Clang -ftime-trace for a PCH'ed QtGui build. Effects on compile times: Clang 10 -ftme-trace: $ ClangBuildAnalyzer --analyze qtgui-before.trace | head -n6 Analyzing build trace from 'qtgui-before.trace'... **** Time summary: Compilation (523 times): Parsing (frontend): 628.3 s Codegen & opts (backend): 304.5 s $ ClangBuildAnalyzer --analyze qtgui-after.trace | head -n6 Analyzing build trace from 'qtgui-after.trace'... **** Time summary: Compilation (523 times): Parsing (frontend): 546.0 s Codegen & opts (backend): 304.4 s GCC 11 time (bash builtin): before: $ time for ((i=0; i < 3; ++i)) do touch src/gui/painting/qpolygon.h ; ninja libQt6Gui.so; done real 4m13,539s user 49m24,416s sys 3m18,177s after: $ time for ((i=0; i < 3; ++i)) do touch src/gui/painting/qpolygon.h ; ninja libQt6Gui.so; done real 3m55,697s user 45m19,941s sys 3m7,370s Task-number: QTBUG-97601 Pick-to: 6.3 Change-Id: Ia8e37a58937568a7ed21cfeb4b27274deca4d53b Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
* Document that QStandardPath::findExecutable works with absolute pathsAlbert Astals Cid2022-01-211-0/+3
| | | | | | Change-Id: Ib993fa9a5f2c68febac9820e241c8617bb8ba5bc Pick-to: 6.3 6.2 5.15 Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
* Doc: Fix typo in \externalpage commandTopi Reinio2022-01-071-1/+1
| | | | | | Pick-to: 6.3 6.2 5.15 Change-Id: I7a2dd1057dae5424f27da314e56dbfad6e34e438 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Doc: Update external links to Qt Creator ManualLeena Miettinen2022-01-041-205/+51
| | | | | | | | | | | | | | 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. Pick-to: 5.15 6.2 Change-Id: Ie4f07b0a1602f3318ca5335ee72130ddce12801e Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* Update copyright year to 2022Kai Köhne2022-01-044-4/+4
| | | | | | | Pick-to: 5.15 6.2 6.3 Change-Id: If6f1d6f9f82a601f8e2b6d36650d6e737518aa60 Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Add link targets for Qt Design Studio Manual topicsLeena Miettinen2022-01-031-0/+709
| | | | | | | | | | You can use these link targets in Qt docs to refer to QDS topics. Pick-to: 6.2 Change-Id: I4d4e288e1456ef92c5e8d9949390a431220eab75 Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
generated by cgit v1.2.3 (git 2.25.1) at 2024-05-06 02:24:09 +0000