summaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Drop Qt3 supportIvan Tkachenko2021-11-271-3/+1
| | | | | | | | | QDoc does not need those defines anymore because there is no Qt3Support library anymore; they are simply not #ifdef guarding any code anymore. Task-number: QTBUG-98650 Change-Id: I42b9c3ce025f639ce6282102b5eadb52fea7fa8e Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* Long live Q_GADGET_EXPORT!Marc Mutz2021-11-271-0/+1
| | | | | | | | | | | | | | | | | | | | | | Like Q_NAMESPACE_EXPORT for Q_NAMESPACE, this variant of Q_GADGET allows passing an export macro. This is useful to avoid exporting the whole class just to get the staticMetaObject hidden therein exported. Before anyone asks: No, we don't need Q_OBJECT_EXPORT, because QObject subclasses, being polymorphic, always need to have a class-level export macro (to export their vtable), but while that technique also works for value classes (the Q_GADGET audience), it is not desirable for them, because it makes inline functions exported in Windows debug builds, which is not what we want, because it needlessly restricts what you can to with the inline functions (e.g. remove). [ChangeLog][QtCore] Added the Q_GADGET_EXPORT macro, which is like Q_GADGET, but allows passing an export macro (like Q_NAMESPACE_EXPORT for Q_NAMESPACE). Fixes: QTBUG-55458 Change-Id: I546297de1e8aa45d83381991bcd3fbca61e1eef0 Reviewed-by: Edward Welbourne <edward.welbourne@qt.io>
* Doc: Add \QtMajorVersion macroTopi Reinio2021-11-101-2/+3
| | | | | | | | | This macro expands to the major version of Qt, complementing the already existing \QtMinorVersion macro. Pick-to: 6.2 5.15 Change-Id: I64861f8cc50d73f34369311a19b5e554645a4127 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Add styling for note/warning/important admonitionsTopi Reinio2021-11-032-28/+26
| | | | | | | | | | | The offline CSS already had some related rules, but at some point QDoc lost the ability to produce the required markup. It has now been reintroduced. Pick-to: 6.2 5.15 Task-number: QTBUG-97448 Change-Id: I5165cd01f3653dfb35854ca6b8040e8daa434347 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Fix usage of \summary macroTopi Reinio2021-10-121-1/+3
| | | | | | | | | 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>
* Doc: Add summary to CMake commandsKai Köhne2021-10-041-0/+3
| | | | | | | | | | | | 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>
* Doc: Update Microsoft's Documentation LinksLuca Di Sera2021-09-231-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | The documentation links on `msdn.microsoft.com` now redirect to `docs.microsoft.com`. While the redirection works, 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 links were modified to point to the equivalent address in the new domain. Furthermore, the link to the `Winsock 2 Socket Handle` was moved to be an `\externalpage` link, as it was used in two different places. Additionally, the `\externalpage` link titled `Dirext X SDK` was removed as it was not used in any part of the documentation. Task-number: QTBUG-96127 Pick-to: 6.2 6.2.0 Change-Id: I07f0ae8d610a7f8322b892a2fa37a5cc1769289e Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Centralize RFC documentation-links in rfc.qdocLuca Di Sera2021-09-161-0/+95
| | | | | | | | | | | | | | | | | | | | 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: Repair broken link to the Netscape Cookie SpecificationLuca Di Sera2021-09-151-1/+1
| | | | | | | | | | | | The link was replaced with an equivalent one from the Internet Archive's Wayback Machine, as it is the one used in RFC-6265 (https://datatracker.ietf.org/doc/html/rfc6265#ref-Netscape) to deliver the same information. Task-number: QTBUG-96127 Pick-to: 6.2 Change-Id: I3d8b7ac511e040c1b4651b59ddedfa580c45ce90 Reviewed-by: Mårten Nordheim <marten.nordheim@qt.io>
* Doc: Update \externalpage links for RFCLuca Di Sera2021-09-151-22/+27
| | | | | | | | | | | | | | The `rfc.qdoc` file was modified to order the external RFC link by RFC number. Furthermore, the links were modified to use the `datatracker.ietf.org` domain to be consistent with the recent changes to the old `tools.ietf.org` links. Task-number: QTBUG-96127 Pick-to: 6.2 Change-Id: I865e7ea131264d0b123f34d796b7ec8007931adc Reviewed-by: Mårten Nordheim <marten.nordheim@qt.io>
* Doc: Update some links to Microsoft's documentationLuca Di Sera2021-09-131-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The documentation links on `msdn.microsoft.com` and `msdn2.microsoft.com` now redirect to `docs.microsoft.com`. Some of the links in the documentation were to those domains. In particular: - An `\externalpage` link to the `Mitigating Cross-site Scripting With HTTP-only Cookies` article. - An `\externalpage` link to `Microsoft Actibe Accessibility Event Constants` - A link to the `RtlGetVersion` function in `qoperatingsystemversion.cpp` - A link to the `GetCommandLine` function in `qcoreapplication.cpp` - A link to the `KNOWNFOLDERID` constant in `qfiledialog.cpp` While the redirection works, 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 above links were modified to point to the equivalent address in the new domain. Task-number: QTBUG-96127 Pick-to: 6.2 Change-Id: I0e9a132f06af7fc43bca6c8ad2054feb6e3e27cd Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Android: Enable QDesktopServiceLars Schmertmann2021-09-101-0/+20
| | | | | | | | | | | | QDesktopServices::openUrl(const QUrl &url) is already implemented on Android. But even if it is possible to set an URL handler, the mechanism to invoke it is missing. With this commit the URL handler will work on Android like it is already working on iOS. Task-number: QTBUG-84382 Pick-to: 6.2 Change-Id: Ic560bd380f1cc59586861aa1a6a3ea064276a39e Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io>
* Doc: Add global \versionlessCMakeCommandsNote qdoc macroJoerg Bornemann2021-08-231-0/+2
| | | | | | | | | | | | | | When documenting a CMake command, document the unversioned command 'qt_foo' and use '\versionlessCMakeCommandNote qt6_foo' to refer to the versioned command. This avoids duplicating the command signature. Use the new macro where applicable. Pick-to: 6.2 Task-number: QTBUG-95796 Change-Id: I2e4180fbda0b89acf3d8c036459f591eb2f46475 Reviewed-by: Craig Scott <craig.scott@qt.io> Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
* Add note on selecting the device which is used to run tests on AndroidAssam Boudjelthia2021-08-181-0/+4
| | | | | | Pick-to: 6.2 5.15 Change-Id: I9bcff18ca11fbbfdff968e29190cae488de56263 Reviewed-by: Edward Welbourne <edward.welbourne@qt.io>
* Doc: Terminate C-commentPaul Wicking2021-06-301-0/+1
| | | | | | Pick-to: 6.2 6.1 Change-Id: I18d3e609781c0f8d518982292279b497dac539a5 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Use https for links to unicode.orgPaul Wicking2021-06-251-0/+4
| | | | | | | | | | * Change all outbound links in user-facing documentation. * Reflow lines that exceed 100 cols as mandated by clang-format. * Add unicode.org as a global \externalsite. Pick-to: 6.2 6.1 5.15 Change-Id: I2ba1e434aa913e678406d62c2801f1a8b2d9e4f4 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: CSS: Update selectors for target highlightingTopi Reinio2021-06-071-1/+1
| | | | | | | | | | | | Certain targets on the generated HTML still use the obsolete <a name=""> method of creating an anchor. Add a rule for a replacement <span> element, using the id attribute. This ensures that the highlighting animations continue to work after the use of obsolete HTML is dropped from QDoc. Change-Id: I2b70470b08d0e0f70702ad2820f4e065f2c08ff5 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* doc: Remove vertical space before youtube video links in offline modeKai Köhne2021-06-042-5/+1
| | | | | | | | | | The vspan was originally added for iframes. They are not needed (and look weird) for normal images/links. Pick-to: 6.1 Fixes: QTBUG-92266 Change-Id: I9da2b52234b2e49bc0cdef4bf8f0865fb092bb31 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Rewrite the fetchmore exampleFriedemann Kleint2021-04-231-0/+0
| | | | | | | | | | | | | - Start in root folder so that large directories (/bin/, Windows) are easily reachable - Remove the line edit and navigate by double clicking instead since this is more in line with expectations - Use a QPlainTextEdit for logging - Make the log message more informative - Add icons Change-Id: Ia3cd7fc143efef80772923291f0b711913aa47be Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Offline documentation CSS: Remove external link icon from video linksTopi Reinio2021-02-191-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 Reinio2021-02-191-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 Reinio2021-02-191-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>
* Remove the qmake project filesJoerg Bornemann2021-01-071-9/+0
| | | | | | | | | | | | | | | | Remove the qmake project files for most of Qt. Leave the qmake project files for examples, because we still test those in the CI to ensure qmake does not regress. Also leave the qmake project files for utils and other minor parts that lack CMake project files. Task-number: QTBUG-88742 Change-Id: I6cdf059e6204816f617f9624f3ea9822703f73cc Reviewed-by: Edward Welbourne <edward.welbourne@qt.io> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Kai Koehne <kai.koehne@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>
* CMake: Allow docs generation without installing in top-level buildsJoerg Bornemann2020-10-231-3/+7
| | | | | | | | | | | | | | This patch allows in top-level prefix builds to build Qt and to generate the documentation without running cmake --install first. For top-level builds we now always use the qdoc binary from the build directory, not the installation directory. We also have to copy the global doc files to the build directory to make them accessible to the generate_docs target. Change-Id: I2251603418fc3df9a21c7f2892789e9ff6c8cc21 Reviewed-by: Alexandru Croitor <alexandru.croitor@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>
* Doc: Remove unused porting guide documentPaul Wicking2020-09-161-54/+0
| | | | | | | | This lives in qtdoc anyway, let's not confuse ourselves. Task-number: QTBUG-84051 Change-Id: Iaf84ecf49cda848ef88aadf108b52713356f1ff8 Reviewed-by: Topi Reiniö <topi.reinio@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-2413-5/+0
| | | | | | Task-number: QTBUG-80316 Change-Id: I2ee74110fd55e94d86321d3b3dc5bb8297424ed4 Reviewed-by: Maurice Kalinowski <maurice.kalinowski@qt.io>
* Fix return of uninitialized pointer in guiloader exampleSander Visser2020-07-161-1/+1
| | | | | | | Signed-off-by: Sander Visser <github@visser.se> Change-Id: I7e23402562bd560d55bb811e5e61cca4fcfe247d Reviewed-by: Jean-Michaël Celerier <jean-michael.celerier@kdab.com> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@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-202-69/+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>
generated by cgit v1.2.3 (git 2.25.1) at 2024-05-03 11:06:25 +0000